web-dev-qa-db-fra.com

github Readme - problème de référence

Comment puis-je référencer (insérer un lien relatif vers) un problème dans mon fichier Readme.md github?

J'ai trouvé le document suivant GitHub Flavored Markdown où il est décrit comment faire référence à un problème dans un commit, mais pas dans le readme.

Par exemple. si le problème est: https://github.com/user/project/issues/5 comment puis-je définir un lien vers celui-ci dans mon readme sans utiliser de liens absolus?

githubmarkdown
57
Stefan Profanter

Ce n'est pas ( officiellement ) possible. GitHub Flavored Markdown n'est pas utilisé pour rendre les fichiers de démarque dans votre dépôt, il n'est utilisé que pour les problèmes et les commentaires. Ainsi, les fichiers readme sont rendus en utilisant le démarquage normal et aucune liaison automatique ne se produira pour les problèmes, les SHA et les constructions similaires.

24
Ivan Zuzak

Il y a une manière assez moche de faire quelque chose comme ça si vous voulez seulement faire référence aux problèmes du même dépôt, qui à partir du 29/04/2015 fonctionne:

see also [#3](/../../issues/3)
46
Eduardo Pareja Tobes

Ce n'est pas strictement la solution à votre question, mais peut-être la solution à votre problème.

Je voulais moi aussi éviter d'ajouter des URL absolues aux liens dans mon CHANGELOG, car cela rendrait les lignes si longues et illisibles.

Mais lorsque vous utilisez des liens de style de référence, ce n'est pas trop mal:

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

L'un des gros avantages est qu'il fonctionne également en dehors de Github.

21
Danilo Bargen