2013-05-14 5 views
37

Как я могу ссылаться (вставить относительную ссылку на) проблему в моем github Readme.md?github Readme - справочная проблема

Я нашел следующий документ GitHub Flavored Markdown, где описано, как ссылаться на проблему в фиксации, но не в readme.

E.g. если проблема: https://github.com/user/project/issues/5 как я могу установить ссылку на нее в моем readme без использования абсолютных ссылок?

ответ

17

Это не (officially) возможно. GitHub Flavored Markdown не используется для рендеринга файлов разметки в вашем репо, он используется только для вопросов и комментариев. Таким образом, файлы readme визуализируются с использованием обычной уценки, и автоматизация не будет выполняться для проблем, SHA и подобных конструкций.

+1

Однако вы все еще можете иметь списки задач и таблицы только для чтения. –

37

Там довольно некрасиво способ сделать что-то вроде этого , если вы хотите, чтобы обратиться к проблемам с той же репо, что по состоянию на 2015-04-29 работ:

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

Хорошее использование [относительных ссылок GitHub] (https://github.com/blog/1395-relative-links-in-markup-files);) – Dennis

+0

также, это работает только с именем ветки _without_ slashes –

+0

.. .или добавить сколько-нибудь лишних '../' по мере необходимости –

10

Это не строго решение вашего вопроса, но, возможно, решение вашей проблемы.

Я тоже хотел избегать добавления абсолютных URL-адресов в ссылки в моем CHANGELOG, потому что это сделало бы строки такими длинными и нечитаемыми.

Но при использовании ссылки ссылки стиль, это не так уж плохо:

* [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.

Смежные вопросы