Markdown文件中的GitHub相对链接
有没有一种方法可以创建一个URL锚点, <a>
,从Markdown文件中的链接到同一个存储库和分支中的另一个文件(又名相对于当前分支的链接)?
例如,在主分支中,我有一个README.md文件,我希望这样做:
# My Project
is really really cool. My Project has a subdir named myLib, see below.
## myLib documentation
see documentation [here](myLib/README.md)
这将允许我在同一分支内从一个.md链接到另一个,而不必担心我在哪个分支(避免必须执行包含github.com分支名称的绝对URL)。
这里是我的意思的一个工作例子:
这是预料之中的,因为此时起始URL位于分支中。 现在,我该如何获取它在存储库根目录下的README.md中的当前分支?
更新 :我针对此功能请求向GitHub打开了一个问题。
更新2013年1月30日 ,16个月后:
GitHub博客文章标记文件中的相对链接 :
从今天开始, GitHub支持标记文件中的相关链接 。
现在,您可以直接在不同的文档文件之间进行链接,无论您是使用不同的标记渲染器在GitHub上查看文档,还是在本地查看文档。
你想要的链接定义的例子,以及它们如何工作? 这里有一些适合你的Markdown。
而不是绝对的联系:
[a link](https://github.com/user/repo/blob/branch/other_file.md)
...你可以使用相对链接:
[a relative link](other_file.md)
我们将确保它链接到user/repo/blob/branch/other_file.md
。
如果您正在使用[a workaround link](repo/blob/master/other_file.md)
类[a workaround link](repo/blob/master/other_file.md)
,则必须更新文档以使用新的语法。
这也意味着您的文档现在可以轻松地独立运行,而不必总是指向GitHub 。
2011年12月20日更新:
GitHub标记问题84目前由technoweenie关闭,评论如下:
我们尝试为此添加一个<base>
标记,但它会导致网站上其他相关链接出现问题。
2011年10月12日:
如果您查看Markdown本身(!) 的README.md
的原始来源,则似乎不支持相对路径。
你会发现像这样的参考:
[r2h]: http://github.com/github/markup/tree/master/lib/github/commands/rest2html
[r2hc]: http://github.com/github/markup/tree/master/lib/github/markups.rb#L13
例如,您有一个类似以下的回购:
project/
text.md
subpro/
subtext.md
subsubpro/
subsubtext.md
subsubpro2/
subsubtext2.md
相对链接subtext.md
在text.md
可能是这样的:
[this subtext](subpro/subtext.md)
subsubtext.md
中text.md
的相关链接可能如下所示:
[this subsubtext](subpro/subsubpro/subsubtext.md)
subtext.md
中subsubtext.md
的相对链接可能如下所示:
[this subtext](../subtext.md)
subsubtext2.md
中的subsubtext.md
的相对链接可能如下所示:
[this subsubtext2](../subsubpro2/subsubtext2.md)
text.md
中subsubtext.md
的相对链接可能如下所示:
[this text](../../text.md)
截至2013年1月31日,Github markdown支持文件的相关链接。
[a relative link](markdown_file.md)
但是,这个评论主题已经讨论了一些缺陷。
作为替代方案,您可以使用Gitdown构建完整的URL到存储库,甚至让它们分支感知,例如
{"gitdown": "gitinfo", "name": "url"} // https://github.com/gajus/gitdown
{"gitdown": "gitinfo", "name": "branch"} // master
Gitdown是一个GitHub降价预处理器。 它简化了与维护GitHub存储库的文档页面相关的常见任务,例如生成目录,包括变量,生成URL并在处理输入时获取关于存储库本身的信息。 Gitdown与您的建筑脚本无缝集成。
我是Gitdown库的作者。
链接地址: http://www.djcxy.com/p/3415.html上一篇: GitHub relative link in Markdown file
下一篇: What file uses .md extension and how should I edit them?