从 README 到 wiki 页面的 github 链接答案

【问题标题】：github link to wiki page from README从 README 到 wiki 页面的 github 链接
【发布时间】：2019-06-21 07:00:00
【问题描述】：

如何创建一个从 README.md 文件到 github 中的 Wiki 页面的链接？每个示例似乎都显示了从一个 wiki 页面链接到另一个 wiki 页面，或从一个 README 文件链接到存储库中的另一个文件。但没有一个显示从一个链接到另一个

【问题讨论】：

你是对的。 “从一个 README 文件到存储库中的另一个文件”确实有效，官方参考 help.github.com/articles/relative-links-in-readmes 官方博客 github.com/blog/1395-relative-links-in-markup-files ，另见 bibwild.wordpress.com/2013/01/30/… 。
深入了解为什么从 README 链接到 wiki 不是那么理想：“当然，您可以链接到您的 wiki — 但 wiki 没有与源代码一起进行版本控制，您希望链接到与您正在查看的源代码库的确切快照一起使用的文档版本。当然，您可以使用绝对 URL 超链接链接出去 - 但同样的问题，当您想要链接到时，您总是链接到 master读者正在查看自述文件的同一快照中的文件。”来源：bibwild.wordpress.com/2013/01/30/…

标签： github

【解决方案1】：

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

如果您查看relative links on 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)

更新：正如一些人在 cmets 中指出的（谢谢！），请注意这些相关链接会在克隆和分叉上中断，因此请务必在您的决定中权衡这一点！

【讨论】：

有趣，但请注意 README.md 可以从本地克隆而不是 Web 中查看。在这种情况下，唯一有效的就是带有绝对 URL 的链接。
好点子，@StéphaneGourichon，我没有考虑在本地查看自述文件。虽然我认为如果需要相对链接，这是一个可以接受的限制。
您可以在本地克隆 wiki 作为单独的 git repo：stackoverflow.com/questions/15080848/…
警告：当查看像 README.md 这样的单个文件和提交的特定 blob 时，这是行不通的。
Stephane Gourichon 提到，相对链接并不总是可行的。另一个例子是，如果你希望你的包可以通过第三方开源平台安装。对于 Python，这是 PyPi。 PyPi 将在描述中加载，但所有相关链接都将被破坏。在这种情况下，您需要使用绝对 URL。

【解决方案2】：

您必须使用绝对 URL 而不是相对 URL。

例如：

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

【讨论】：

【解决方案3】：

我发现我需要爬回 3 个级别，而不是 jmar777 方法中描述的 2 个级别。

当我使用时

../../wiki

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

我需要使用：

../../../wiki

这会生成https://github.com/<username>/wiki

【讨论】：

【解决方案4】：

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

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

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

【讨论】：

【解决方案5】：

只是添加这个，如果你想从 wiki 内部引用你的 repo 文件，请使用../../blob/master/。结合 jmar777 的答案，这允许完全集成代码和 wiki 并消除对臃肿 readme.md 的需要。

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

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

【讨论】：