github自述文件 - 参考问题

Question

github自述文件 - 参考问题

Ste*_*ter 54 markdown github

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

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

例如,如果问题是:https://github.com/user/project/issues/5如何在我的自述文件中设置链接,而不使用绝对链接？

Answer 1

Edu*_*bes 48

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

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

Run Code Online (Sandbox Code Playgroud)

很好用[GitHub的相关链接](https://github.com/blog/1395-relative-links-in-markup-files);) (4认同)

Answer 2

Iva*_*zak 26

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

来自：https://guides.github.com/features/mastering-markdown/ “您可以在 GitHub 周围的大多数地方使用 Markdown：” .. “带有 .md 或 .markdown 扩展名的文件” 无法链接到 git 提交该指南中描述的问题或问题会产生额外的、不必要的工作。 (2认同)

Answer 3

Dan*_*gen 23

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

我也想避免向我的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

Run Code Online (Sandbox Code Playgroud)

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

归档时间：	12 年，7 月前
查看次数：	8117 次
最近记录：	8 年，2 月前