在Markdown文件中的GitHub相对链接

是否有一种方法来创建一个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上打开了一个问题。

当前回答

GitHub可以用最少的工作让它变得更好。这里有一个变通办法。

我觉得你想要的是

[Your Title](your-project-name/tree/master/your-subfolder)

或者指向README本身

[README](your-project-name/blob/master/your-subfolder/README.md)

其他回答

你也可以在底部插入你的链接(相对的或绝对的)，以减少文本的混乱。对于重复链接，它也是一个很好的选择。

This is [my linked text].

  [my linked text]: relative/path/in/repo/to/file.txt "Optional title for mouse hover"

这是我的链接文本。

你可以链接到文件，但不能链接到文件夹，并记住，Github将添加/blob/master/在你的相对链接之前(和文件夹缺乏这部分，所以他们不能被链接，也不能与HTML < >标签或Markdown链接)。

因此，如果我们在myrepo/src/Test.java中有一个文件，它将有一个这样的url:

https://github.com/WesternGun/myrepo/blob/master/src/Test.java

要在自述文件中链接它，我们可以使用:

[This is a link](src/Test.java)

or: <a href="src/Test.java">这是一个链接</a>. java

(我猜，master代表主分支，当文件在另一个分支中时，情况就不同了。)

如果你想要一个相对链接到你的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”路径。，然后转到存储库树中的主分支，而不指定存储库名称(将来可能会更改)。

截至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图书馆的作者。

这个问题很老了，但它似乎仍然很重要，因为从自述中输入相对引用并不容易。md到Github上的wiki页面。

我尝试了一下，这种相对联系似乎很有效:

[你的wiki页面](../../wiki/ Your -wiki-page)

两个…/将删除/blob/master/，并使用你的基础作为起点。除了Github之外，我还没有在其他存储库上尝试过这一点(可能存在兼容性问题)。

推荐文章