4c0ad5238e
This commit includes the following changes: * CLI version information is read from the CLI package from which we read the help files. * CLI API pages now contain GH links * line numbers are not shown in GH links, if the doc does not have a truthy `startingLine` value. This allows us to remove hard coded checks for `guide` pages * content pages and CLI api docs no longer have a `startingLine` * the hard-coded `packages` path segment has been removed from the templates; instead we now only use the `realProjectRelativePath`. * the `realProjectRelativePath` has been updated accordingly for API and CLI API docs. PR Close #26515
37 lines
1.9 KiB
HTML
37 lines
1.9 KiB
HTML
{% macro projectRelativePath(fileInfo) -%}
|
|
{$ fileInfo.realProjectRelativePath if fileInfo.realProjectRelativePath else fileInfo.projectRelativePath $}
|
|
{%- endmacro %}
|
|
|
|
{% macro githubViewHref(doc, versionInfo) -%}
|
|
{% set githubUrl = 'https://github.com/' + versionInfo.gitRepoInfo.owner + '/' + versionInfo.gitRepoInfo.repo -%}
|
|
{% set version = versionInfo.currentVersion.isSnapshot and versionInfo.currentVersion.SHA or versionInfo.currentVersion.raw -%}
|
|
{% set lineInfo = doc.startingLine and ('#L' + (doc.startingLine + 1) + '-L' + (doc.endingLine + 1)) or '' -%}
|
|
{$ githubUrl $}/tree/{$ version $}/{$ projectRelativePath(doc.fileInfo) $}{$ lineInfo $}
|
|
{%- endmacro %}
|
|
|
|
{% macro githubEditHref(doc, versionInfo, pathPrefix) -%}
|
|
{% set githubUrl = 'https://github.com/' + versionInfo.gitRepoInfo.owner + '/' + versionInfo.gitRepoInfo.repo -%}
|
|
{% set lineInfo = doc.startingLine and ('#L' + (doc.startingLine + 1) + '-L' + (doc.endingLine + 1)) or '' -%}
|
|
{$ githubUrl $}/edit/master/{$ projectRelativePath(doc.fileInfo) $}?message=docs
|
|
{%- if doc.moduleDoc %}({$ doc.moduleDoc.id.split('/')[0] $})
|
|
{%- elseif doc.docType === 'module' %}({$ doc.id.split('/')[0] $})
|
|
{%- elseif doc.docType === 'content' %}
|
|
{%- else %}(...){%- endif -%}
|
|
%3A%20describe%20your%20change...{$ lineInfo $}
|
|
{%- endmacro %}
|
|
|
|
{% macro githubEditLink(doc, versionInfo) -%}
|
|
<a href="{$ githubEditHref(doc, versionInfo) $}" aria-label="Suggest Edits" title="Suggest Edits"><i class="material-icons" aria-hidden="true" role="img">mode_edit</i></a>
|
|
{%- endmacro %}
|
|
|
|
{% macro githubViewLink(doc, versionInfo) -%}
|
|
<a href="{$ githubViewHref(doc, versionInfo) $}" aria-label="View Source" title="View Source"><i class="material-icons" aria-hidden="true" role="img">code</i></a>
|
|
{%- endmacro %}
|
|
|
|
{% macro githubLinks(doc, versionInfo) -%}
|
|
<div class="github-links">
|
|
{$ githubEditLink(doc, versionInfo) $}
|
|
{$ githubViewLink(doc, versionInfo) $}
|
|
</div>
|
|
{%- endmacro -%}
|