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


当前回答

在.md文件中,当您想要创建与同一项目文件夹或基于URL的链接相关的任何相关文件的链接时:

现有文件链接:

在.md文件中,在[]框中添加显示名称,然后在此框中打开(),在此框中添加/之后,它将自动获取所有现有文件夹的名称形式,您选择的文件夹,然后添加'/',它将显示内部文件或'文件夹'。这意味着它将自动获取路径,在结束时,创建您的URL。

例子:

[Enter Showing Name](/users/4000266/heysushil)

这一行是这样显示的: 输入显示名称

在.md文件中添加url

遵循相同的过程,只更改()框的URL路径,如下所示:

 [HeySushil - YouTube](https://youtube.com/heysushil)

这看起来像HeySushil - YouTube

注意:记住在添加/ on()框后不需要手动添加force,它将自动获取所有现有的文件夹和文件。

其他回答

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

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

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

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

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

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

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

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

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

我不确定我是否看到了这个选项。你可以在你的存储库中创建一个/文件夹,并直接使用它:

[a relative link](/folder/myrelativefile.md)

不需要blob或树或存储库名称,它的工作就像一个魅力。

在.md文件中,当您想要创建与同一项目文件夹或基于URL的链接相关的任何相关文件的链接时:

现有文件链接:

在.md文件中,在[]框中添加显示名称,然后在此框中打开(),在此框中添加/之后,它将自动获取所有现有文件夹的名称形式,您选择的文件夹,然后添加'/',它将显示内部文件或'文件夹'。这意味着它将自动获取路径,在结束时,创建您的URL。

例子:

[Enter Showing Name](/users/4000266/heysushil)

这一行是这样显示的: 输入显示名称

在.md文件中添加url

遵循相同的过程,只更改()框的URL路径,如下所示:

 [HeySushil - YouTube](https://youtube.com/heysushil)

这看起来像HeySushil - YouTube

注意:记住在添加/ on()框后不需要手动添加force,它将自动获取所有现有的文件夹和文件。

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