Включение справочных ссылок в уценку в виде маркированного списка на GitHub

В настоящее время я использую этот текст уценки в файле README.md проекта на GitHub:

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
person janos    schedule 12.09.2014    source источник

Ответы (2)


arrow_upward
15
arrow_downward

Вдохновленный @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-адресах.

person janos    schedule 15.09.2014

arrow_upward
8
arrow_downward

Я бы написал это следующим образом:

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

Это ответило на ваш вопрос? Если нет, то вам придется это уточнить.

person mb21    schedule 15.09.2014