是否有一种方法来创建一个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上打开了一个问题。
例如,你有一个像这样的回购:
project/
text.md
subpro/
subtext.md
subsubpro/
subsubtext.md
subsubpro2/
subsubtext2.md
潜台词的相对链接。文本中的Md。Md可能是这样的:
[this subtext](subpro/subtext.md)
与潜台词的相对链接。文本中的Md。Md可能是这样的:
[this subsubtext](subpro/subsubpro/subsubtext.md)
潜台词的相对链接。潜台词里的Md。Md可能是这样的:
[this subtext](../subtext.md)
subsubtext2的相对链接。潜台词里的Md。Md可能是这样的:
[this subsubtext2](../subsubpro2/subsubtext2.md)
到文本的相对链接。潜台词里的Md。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 markdown预处理器。它简化了与维护GitHub存储库文档页面相关的常见任务,例如,生成目录,包括变量,生成url,并在处理输入时获得关于存储库本身的信息。Gitdown与您的构建脚本无缝集成。
我是Gitdown图书馆的作者。
如果你想要一个相对链接到你的GitHub上的维基页面,使用这个:
Read here: [Some other wiki page](path/to/some-other-wiki-page)
如果你想要一个链接到存储库中的一个文件,比如说,引用一些头文件,而wiki页面位于wiki的根,使用这个:
Read here: [myheader.h](../tree/master/path/to/myheader.h)
最后一种方法的基本原理是用“..”跳过“/wiki”路径。,然后转到存储库树中的主分支,而不指定存储库名称(将来可能会更改)。
我发现适用于相对文件夹的方法:
[link text](subfolder/subsubfolder/relevantfolder/)
相关的文件夹是你试图链接到的文件夹。文件夹名称后面需要反斜杠。我尝试在路径中包含项目名称和tree/main,以及前面的答案中建议的其他内容,这导致了不存在的页面错误。子文件夹是整个回收项目文件夹中的一个文件夹。
因此,文件链接的形式是:
[link text](subfolder/subsubfolder/relevantfolder/index.html)
如果需要的文件不在任何文件夹或子文件夹中,链接很简单:
[link text](README.md)
例如,README文件不在任何子文件夹中,因此这可能是您用于README文件的确切相对链接。