github从README链接到Wiki页面

91

如何创建从README.md文件到github中的Wiki页面的链接？每个示例似乎都显示从一个Wiki页面链接到另一个Wiki页面，或者从一个README文件链接到存储库中的另一个文件。但是没有一个显示出彼此之间的联系

github

— 面纱
source

你是对的。“从一个自述文件到存储库中的另一个文件”确实有效，官方参考帮助。github.com/articles/relative-links-in- readmes官方博客github.com/blog/1395-relative-links-in-markup-文件，另请参阅bibwild.wordpress.com/2013/01/30/…。

— 斯特凡纳·古里科

了解为什么不那么需要从README到Wiki的链接：“当然，您可以链接到您的Wiki-但是Wiki没有与源代码一起进行版本控制，并且您希望链接到随同的文档版本当然，您可以使用绝对URL超链接进行链接-但同样的问题，当您要链接到与读者相同的快照中的文件时，您总是链接到master正在查看README。” 来源：bibwild.wordpress.com/2013/01/30/...

— 斯特凡纳·古里科

67

您将必须使用绝对URL，而不要使用相对URL。

例如：

[Sites Using React](https://github.com/facebook/react/wiki/Sites-Using-React)

— 最大偏差
source

4

好的，那就是我的想法-只是想确保没有更好的方法。

— veilig 2014年

2

在@ jmar777链接的文档中，它警告使用绝对URL：“克隆您的存储库的用户要使链接正常工作将比想象的要困难得多。”

— 戴夫·塞克斯顿

@DaveSexton特别是指链接到存储库中的其他文件（始终相对于README）。链接到外部内容（例如Wiki）时，您要使用绝对URL。

— maxdeviant

92

我刚遇到这个问题，发现这是不可能的，但是无论如何还是顽固地尝试着。好消息，因为这实际上可以通过相对链接完成！

如果查看GitHub上相关链接的文档，则可以看到它支持./和../操作数。

鉴于您的自述文件位于：

https://github.com/<user-name>/<repo-name>/blob/master/README.md

...且Wiki位于：

https://github.com/<user-name>/<repo-name>/wiki

...这意味着您可以从README爬回到Wiki，就像这样：

[My Awesome Wiki](../../wiki)

更新：正如一些人在评论中指出的（谢谢！），请注意，这些相对链接将在克隆和派生上中断，因此请务必在您的决定中权衡一下！

— jmar777
source

15

有趣，但请注意，可以从本地克隆而不是从网络查看README.md。在这种情况下，唯一起作用的是带有绝对URL的链接。

— 斯特凡纳·古里科

1

好的，@StéphaneGourichon，我没有考虑过本地阅读自述文件。尽管我想是否需要相对链接，但这是可以接受的限制。

— jmar777'3

2

：您可以在本地复制维基作为一个单独的git仓库stackoverflow.com/questions/15080848/...

— EriF89

3

警告词：当查看单个文件（例如a）README.md和特定的blob以进行提交时，此操作将无效。

— kaiser

正如斯蒂芬·古里雄（Stephane Gourichon）所提到的，相对链接并不总是可行的。另一个示例是，如果您希望通过第三方开放源代码平台安装软件包。对于Python，这是PyPi。PyPi将在说明中加载，但所有相关链接都将断开。在这种情况下，您需要使用绝对URL。

— cgnorthcutt

1

如果您想从wiki use内部引用您的repo文件，只需添加一个即可../../blob/master/。结合jmar777的答案，可以完全集成代码和Wiki，而无需冗长的readme.md。

要使其在本地工作以及您的文件结构必须是

./Wiki/YourWikiRepo
./blob/master/YourCodeRepo

— 财务部
source

1

我发现我需要按照jmar777的方法中的描述，向后爬取3个级别和2个级别。

当我使用

../../wiki

生成的链接为 https://github.com/<username>/blob/wiki

我需要使用：

../../../wiki

这产生了 https://github.com/<username>/wiki

— 格林德尔
source

1

我正在使用GitLab。我到Wiki页面的链接如下所示。

Checkout the [Wiki page](/%2E%2E/wikis/Welcome)

我尝试了此处发布的其他建议，但是它通过重写来不断更改URL，从而破坏了链接。

— Linux大师
source