在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上打开了一个问题。

当前回答

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

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

其他回答

我发现适用于相对文件夹的方法:

[link text](subfolder/subsubfolder/relevantfolder/)

相关的文件夹是你试图链接到的文件夹。文件夹名称后面需要反斜杠。我尝试在路径中包含项目名称和tree/main，以及前面的答案中建议的其他内容，这导致了不存在的页面错误。子文件夹是整个回收项目文件夹中的一个文件夹。

因此，文件链接的形式是:

[link text](subfolder/subsubfolder/relevantfolder/index.html)

如果需要的文件不在任何文件夹或子文件夹中，链接很简单:

[link text](README.md)

例如，README文件不在任何子文件夹中，因此这可能是您用于README文件的确切相对链接。

2023-02-05 23:54:22

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

2016-01-05 17:40:29

只是想添加这个，因为如果目标链接是名称中有空格的目录，上述解决方案都不起作用。如果目标链接是一个目录，并且它有空间，那么即使使用\转义空间也不会在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

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

我觉得你想要的是

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

或者指向README本身

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

2012-08-31 16:16:44

2013年1月30日更新，16个月后:

标记文件中的相对链接:

从今天开始，GitHub支持标记文件中的相对链接。现在，您可以直接链接不同的文档文件，无论您是在GitHub上查看文档，还是使用不同的标记呈现器在本地查看文档。您想要链接定义及其工作方式的示例吗?这是给你的Markdown。而不是绝对的链接: [链接](https://github.com/user/repo/blob/branch/other_file.md) 你可以使用相对链接: [a相对链接](other_file.md) [a相对链接](路径%20with%20spaces/other_file.md) 我们将确保它链接到user/repo/blob/branch/other_file.md。如果您正在使用类似[a workaround link](repo/blob/master/other_file.md)的解决方案，则必须更新文档以使用新语法。这也意味着你的文档现在可以很容易地独立存在，而不需要总是指向GitHub。

Marcono1234在评论中补充道

同样有用的是:当链接以/开头时，它相对于存储库的根目录(不管markdown文件是否嵌套在子目录中)

2011年12月20日更新:

GitHub标记问题84目前已被technoweenie关闭，评论如下:

我们尝试为此添加一个<base>标记，但它会导致网站上其他相对链接出现问题。

2011年10月12日:

如果你看一下README的原始源代码。md的Markdown本身(!)，相对路径似乎不支持。你会发现这样的参考资料:

[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

正如InvisibleWolf的回答中提到的，如果目标链接是一个目录，并且它有空间，那么您需要为每个空间使用%20。

2011-10-05 08:39:27

在Markdown文件中的GitHub相对链接

推荐文章

最新文章

标签