在 GitHub 上将 markdown 中的参考链接作为项目符号列表答案

【问题标题】：Including reference links in markdown as bullet point list on GitHub在 GitHub 上将 markdown 中的参考链接作为项目符号列表
【发布时间】：2014-11-07 01:54:33
【问题描述】：

目前我在 GitHub 上的一个项目的 README.md 文件中使用这个降价文本：

See the docs of [testthat][3] on how to write unit tests.

Links
-----

- http://www.rstudio.com/products/rpackages/devtools/
- https://github.com/hadley/testthat
- http://r-pkgs.had.co.nz/tests.html

---

[1]: http://www.rstudio.com/products/rpackages/devtools/
[2]: https://github.com/hadley/testthat
[3]: http://r-pkgs.had.co.nz/tests.html

我不喜欢这种重复，但我不知道我有什么选择。如果我删除了明确的项目符号列表，那么 GitHub 将不会显示参考链接。如果我删除参考链接，那么 GitHub 会显示项目符号列表（当然），但是像上面的“testthat”这样的嵌入式链接不起作用。

有没有比复制更好的方法？我错过了什么？

【问题讨论】：

标签： github markdown

【解决方案1】：

受@mb21 的启发，我想这是正确的方法：

See the docs of [testthat][2] on how to write unit tests.

Links
-----

- [RStudio Devtools][1]
- [testthat][2]
- [More unit test examples][3]

[1]: https://stackoverflow.com/users/214446/mb21
[2]: https://github.com/hadley/testthat
[3]: http://r-pkgs.had.co.nz/tests.html

也就是说，逐字包含链接并且没有有意义的标题不是一个好习惯。我应该只在底部的参考链接部分保留链接 URL，并在项目符号列表中使用有意义的标题。

当您在 GitHub 上查看此内容时，URL 并不重要，如果您真的想知道，可以将鼠标移到上方。当您以纯文本形式查看时，现在链接具有有意义的标题，这是有关 URL 的有用附加信息。

【讨论】：

【解决方案2】：

我会这样写：

See the docs of [testthat][1] on how to write unit tests.

Links
-----

- [RStudio Devtools](http://www.rstudio.com/products/rpackages/devtools/)
- [Testthat](https://github.com/hadley/testthat)
- [Tests][1]

[1]: http://r-pkgs.had.co.nz/tests.html

这是否回答了您的问题？如果不是，你必须澄清它。

【讨论】：