是否有一种方法来创建一个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上呈现链接。对我来说唯一有效的解决方案是为每个空格使用%20。

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

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

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

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

其他回答

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

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

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

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

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

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

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

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

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

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

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

[link text](README.md)

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

你可以链接到文件,但不能链接到文件夹,并记住,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代表主分支,当文件在另一个分支中时,情况就不同了。)

您可以使用<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>

在标记文件中的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上的目录链接的奇怪行为。