github自述文件 - 参考问题

时间:2013-05-14 09:34:04

标签: github markdown

如何在我的github Readme.md中引用(插入相关链接)问题?

我找到了以下文档GitHub Flavored Markdown,其中描述了如何在提交中引用问题,而不是在自述文件中。

E.g。如果问题是:https://github.com/user/project/issues/5如何在不使用绝对链接的情况下在自述文件中设置指向它的链接?

3 个答案:

答案 0 :(得分:45)

如果你只想引用同一个回购中的问题,那就像做这样的事情有一种非常丑陋的方式,从2015-04-29起作用:

see also [#3](/../../issues/3)

答案 1 :(得分:24)

这不是(officially)可能的。 GitHub Flavored Markdown不用于在您的仓库中渲染markdown文件,它仅用于问题和注释。因此,自述文件使用正常的markdown呈现,并且不会对问题,SHA和类似结构进行自动链接。

答案 2 :(得分:20)

这不是您问题的严格解决方案,但可能是您问题的解决方案。

我也想避免向我的CHANGELOG中的链接添加绝对URL,因为它会使这些行变得太长而且不可读。

但是在使用参考样式链接时,它并不太糟糕:

* [feature] Add an awesome feature ([#33][i33])
* [bug] Finally fixed this stupid bug ([#19][i19])

[i19]: https://github.com/user/repo/issues/19
[i33]: https://github.com/user/repo/issues/33

其中一个很大的优点是它也可以在Github之外工作。