Github API Markdown - 锚链接
Github API Markdown - Anchor Links
我正在为使用 .md
文件的文档编写一个 NodeJS 应用程序,我使用的是:https://www.npmjs.com/package/github which uses this: https://developer.github.com/v3/markdown/.
我将我们的 .md
文件通过它们的 API 传递到 return HTML,然后我将其缓存以备将来使用。
我遇到锚链接问题。
当我有这个:# Standard Parameters
,我得到这些结果:
1。
使用 markdown.render()
与 mode: 'markdown'
和 markdown.renderRaw()
与 mode: 'markdown'
或 mode: 'gfm'
:
<h2><a id="user-content-standard-parameters" class="anchor" href="#standard-parameters" aria-hidden="true"><span class="octicon octicon-link"></span></a>Standard Parameters</h2>
2。
使用 markdown.render()
和 mode: 'gfm'
:
<h2>Standard Parameters</h2>
所以1号生成锚点,2号不生成。
然而,数字 1 似乎根本不起作用。 id
是 user-content-standard-parameters
(没有 name
属性),href
是 #standard-parameters
.
id
值不应该与 href
值匹配吗?像这样:
id="standard-parameters" href="#standard-parameters"
或
id="user-content-standard-parameters" href="#user-content-standard-parameters"
甚至
name="standard-parameters" href="#standard-parameters"
我错过了什么..?
看起来 Github 在他们自己的网站上使用一点 JavaScript 来处理这个问题,所以我添加了一些我自己的东西来添加 name
属性,删除来自 id
值的 user-content-
位。
$(document).ready(function(){
$('a[id^="user-content-"]').each(function(i, a){
$(this).prop('name', a.id.replace('user-content-', ''));
});
});
我正在为使用 .md
文件的文档编写一个 NodeJS 应用程序,我使用的是:https://www.npmjs.com/package/github which uses this: https://developer.github.com/v3/markdown/.
我将我们的 .md
文件通过它们的 API 传递到 return HTML,然后我将其缓存以备将来使用。
我遇到锚链接问题。
当我有这个:# Standard Parameters
,我得到这些结果:
1。
使用 markdown.render()
与 mode: 'markdown'
和 markdown.renderRaw()
与 mode: 'markdown'
或 mode: 'gfm'
:
<h2><a id="user-content-standard-parameters" class="anchor" href="#standard-parameters" aria-hidden="true"><span class="octicon octicon-link"></span></a>Standard Parameters</h2>
2。
使用 markdown.render()
和 mode: 'gfm'
:
<h2>Standard Parameters</h2>
所以1号生成锚点,2号不生成。
然而,数字 1 似乎根本不起作用。 id
是 user-content-standard-parameters
(没有 name
属性),href
是 #standard-parameters
.
id
值不应该与 href
值匹配吗?像这样:
id="standard-parameters" href="#standard-parameters"
或
id="user-content-standard-parameters" href="#user-content-standard-parameters"
甚至
name="standard-parameters" href="#standard-parameters"
我错过了什么..?
看起来 Github 在他们自己的网站上使用一点 JavaScript 来处理这个问题,所以我添加了一些我自己的东西来添加 name
属性,删除来自 id
值的 user-content-
位。
$(document).ready(function(){
$('a[id^="user-content-"]').each(function(i, a){
$(this).prop('name', a.id.replace('user-content-', ''));
});
});