Si vous utilisez le format Markdown (README.md) :
Si vous disposez de l'image dans votre dépôt, vous pouvez utiliser une URL relative :
![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")
Si vous devez intégrer une image hébergée ailleurs, vous pouvez utiliser l'URL complète.
![Alt text](http://full/path/to/img.jpg "Optional title")
GitHub recommande d'utiliser liens relatifs avec le ?raw=true
pour s'assurer que les dépôts bifurqués pointent correctement.
Le site raw=true
est là pour garantir que l'image vers laquelle vous établissez un lien sera rendue telle quelle. Cela signifie que seule l'image sera liée, et non l'ensemble de l'interface GitHub pour ce fichier respectif. Voir ce commentaire pour plus de détails.
Regardez un exemple : https://raw.github.com/altercation/solarized/master/README.md
Si vous utilisez des SVG, vous devrez définir l'attribut sanitize comme suit true
également : ?raw=true&sanitize=true
. (Merci @EliSherer)
Aussi, la documentation sur les liens relatifs dans les fichiers README : https://help.github.com/articles/relative-links-in-readmes
Et bien sûr, la documentation markdown : http://daringfireball.net/projects/markdown/syntax
De plus, si vous créez une nouvelle branche screenshots
pour stocker les images, vous pouvez éviter qu'elles ne se trouvent dans le fichier master
arbre de travail
Vous pouvez ensuite les intégrer en utilisant :
![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")
2 votes
La solution correcte est d'utiliser des références relatives, selon cette réponse stackoverflow.com/a/11916467/1633251 (voir le commentaire avec le lien vers une nouvelle doc github sur la façon de faire cela). La réponse courte est d'utiliser
[Read more words!](docs/more_words.md)
3 votes
La plupart des solutions proposent de pointer vers le repo lui-même. Qu'en est-il si vous voulez éviter les binaires dans le repo (même dans une branche séparée, comme proposé) et que vous voulez le stocker dans un endroit externe ? De bonnes pratiques ? Un gist peut-être (IDK si le gist peut être binaire ou juste du texte) ? créer un autre repo "myproject-assets" pour le projet "myproject" ? Un lieu d'image externe populaire similaire à la norme de facto de youtube pour le téléchargement de vidéos ?
2 votes
Duplicata possible de Ajouter des images au fichier README.md sur GitHub
0 votes
guides.github.com/features/mastering-markdown
0 votes
Mars 2021 : simple drag&drop : Voir ma réponse ci-dessous