是否有一种方法来创建一个URL锚,< >,链接从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)。
这里有一个例子来说明我的意思:
GOTO http://github.com/rynop/testRel,链接不工作。
GOTO http://github.com/rynop/testRel/blob/master/README.md,链接有效。
这是意料之中的,因为此时起始URL在分支中。现在我如何让它在README中拾取当前的分支。Md在存储库的根?
更新:我针对这个功能请求在GitHub上打开了一个问题。
在.md文件中,当您想要创建与同一项目文件夹或基于URL的链接相关的任何相关文件的链接时:
现有文件链接:
在.md文件中,在[]框中添加显示名称,然后在此框中打开(),在此框中添加/之后,它将自动获取所有现有文件夹的名称形式,您选择的文件夹,然后添加'/',它将显示内部文件或'文件夹'。这意味着它将自动获取路径,在结束时,创建您的URL。
例子:
[Enter Showing Name](/users/4000266/heysushil)
这一行是这样显示的:
输入显示名称
在.md文件中添加url
遵循相同的过程,只更改()框的URL路径,如下所示:
[HeySushil - YouTube](https://youtube.com/heysushil)
这看起来像HeySushil - YouTube
注意:记住在添加/ on()框后不需要手动添加force,它将自动获取所有现有的文件夹和文件。
在.md文件中,当您想要创建与同一项目文件夹或基于URL的链接相关的任何相关文件的链接时:
现有文件链接:
在.md文件中,在[]框中添加显示名称,然后在此框中打开(),在此框中添加/之后,它将自动获取所有现有文件夹的名称形式,您选择的文件夹,然后添加'/',它将显示内部文件或'文件夹'。这意味着它将自动获取路径,在结束时,创建您的URL。
例子:
[Enter Showing Name](/users/4000266/heysushil)
这一行是这样显示的:
输入显示名称
在.md文件中添加url
遵循相同的过程,只更改()框的URL路径,如下所示:
[HeySushil - YouTube](https://youtube.com/heysushil)
这看起来像HeySushil - YouTube
注意:记住在添加/ on()框后不需要手动添加force,它将自动获取所有现有的文件夹和文件。
截至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 markdown预处理器。它简化了与维护GitHub存储库文档页面相关的常见任务,例如,生成目录,包括变量,生成url,并在处理输入时获得关于存储库本身的信息。Gitdown与您的构建脚本无缝集成。
我是Gitdown图书馆的作者。