在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目录链接的行为可能会造成一些头痛。

所有有url的文件都以blob开头，

blob/<branch>/<path>/<fileName>

目录的url以树开头:

tree/<branch>/<path>

因此，到目录的相对链接不应该起作用。它指向一个以blob开头的url。神奇的是，Github自动将一些相对路径更改为树路径。不幸的是，url中不包含“..”

我花了一些时间研究Github https://github.com/fluentcodes/GitSamples-GIT/tree/github-readme-links上的目录链接的奇怪行为。

2022-03-30 03:58:54

其他回答

在标记文件中的Github目录链接的行为可能会造成一些头痛。

所有有url的文件都以blob开头，

blob/<branch>/<path>/<fileName>

目录的url以树开头:

tree/<branch>/<path>

因此，到目录的相对链接不应该起作用。它指向一个以blob开头的url。神奇的是，Github自动将一些相对路径更改为树路径。不幸的是，url中不包含“..”

我花了一些时间研究Github https://github.com/fluentcodes/GitSamples-GIT/tree/github-readme-links上的目录链接的奇怪行为。

2022-03-30 03:58:54

您可以使用<a href="">从你的回购根相对url。假设你的repo被命名为testRel，将以下文件放在testRel/README.md中:

# My Project
is really really cool. My Project has a subdir named myLib, see below.

## myLib docs
see documentation:
    * <a href="testRel/myLib">myLib/</a>
    * <a href="testRel/myLib/README.md">myLib/README.md</a>

2012-08-16 18:37:39

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

This is [my linked text].

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

这是我的链接文本。

2021-11-02 12:01:25

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

2014-11-22 17:27:47

只是想添加这个，因为如果目标链接是名称中有空格的目录，上述解决方案都不起作用。如果目标链接是一个目录，并且它有空间，那么即使使用\转义空间也不会在Github上呈现链接。对我来说唯一有效的解决方案是为每个空格使用%20。

例如:如果目录结构是这样的

Top_dir
|-----README.md
|-----Cur_dir1
      |----Dir A
           |----README.md
      |----Dir B
           |----README.md

在README中建立到目录A的链接。你可以这样做:

[Dir 1](Cur_dir1/Dir%20A)

2017-09-13 05:46:37

在Markdown文件中的GitHub相对链接

推荐文章

最新文章

标签