readme.md链接在npm vs github上

时间:2014-11-02 06:57:45

标签: github npm markdown

底线:有没有办法在README.md文件中创建可在NPM和GitHub中工作的锚链接(目录样式)?

大家好,

我有一个README.md文件,它同时在GitHub和NPM上。 在文件的顶部,有一个目录,它只是一个链接列表。 每个链接都应指向文件中的标题。

经过一些谷歌搜索和阅读一些stackoverflow答案后,我尝试了以下内容:

[Overview](#overview) - 但这导致NPM将我的所有链接指向我的GitHub。

我只是对链接进行硬编码,以便它们指向NPM上的正确锚点 - 但显然这意味着任何点击GitHub上的链接的人都将被重定向到NPM页面。

可在此处找到README.md文件:https://github.com/ujc/Layman.js/blob/master/README.md

谢谢!

1 个答案:

答案 0 :(得分:1)

对我有用的是使用纯HTML链接。 Github和NPM降价演示都允许嵌入式HTML,它似乎工作正常。 E.g。

<a href="#my-heading">Link to My Heading</a>

...

# My Heading