Question

目前我在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会显示项目符号列表（当然），但嵌入式链接如＆＃34; testthat＆＃34;以上没有工作。

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

Answer 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的有用附加信息。

Answer 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

这回答了你的问题吗？如果没有，你必须澄清它。

将标记中的参考链接包含在GitHub上的项目符号列表中

2 个答案: