Comment ajouter des images au fichier README.md sur GitHub ?

Question

Récemment, j'ai rejoint GitHub . J'y ai hébergé quelques projets.

J'ai besoin d'inclure des images dans mon fichier README. Je ne sais pas comment faire.

J'ai fait des recherches à ce sujet, mais tout ce que j'ai obtenu, ce sont des liens qui me disent "d'héberger les images sur le web et de spécifier le chemin de l'image dans le fichier README.md".

Existe-t-il un moyen de faire cela sans héberger les images sur des services d'hébergement Web tiers ?

Answer 1

Beaucoup des solutions affichées sont incomplètes ou ne sont pas à mon goût.

• Un CDN externe comme imgur ajoute un outil supplémentaire à la chaîne. Meh.
• La création d'un problème fictif dans le gestionnaire de problèmes est un piratage. Cela crée du désordre et perturbe les utilisateurs. Il est difficile de migrer cette solution vers un fork ou hors de GitHub.
• L'utilisation de la branche gh-pages rend les URLs fragiles. Une autre personne travaillant sur le projet qui maintient la page gh-pages peut ne pas savoir que quelque chose d'externe dépend du chemin vers ces images. La branche gh-pages a un comportement particulier sur GitHub qui n'est pas nécessaire pour héberger des images CDN.
• Le suivi des actifs dans le contrôle de version est une bonne chose. Au fur et à mesure qu'un projet se développe et évolue, c'est un moyen plus durable de gérer et de suivre les modifications apportées par plusieurs utilisateurs.
• Si une image s'applique à une révision spécifique du logiciel, il peut être préférable de lier une image immuable. Ainsi, si l'image est mise à jour ultérieurement pour refléter les modifications apportées au logiciel, toute personne lisant le fichier readme de cette révision trouvera l'image correcte.

Ma solution préférée, inspirée par cette phrase est d'utiliser un branche d'actifs avec permaliens vers des révisions spécifiques .

git checkout --orphan assets
git reset --hard
cp /path/to/cat.png .
git add .
git commit -m 'Added cat picture'
git push -u origin assets
git rev-parse HEAD  # Print the SHA, which is optional, you'll see below.

Construisez un "permalien" vers cette révision de l'image, et emballez-le en Markdown.

Chercher le commit SHA à la main n'est pas pratique, cependant, donc comme raccourci, appuyez sur Y pour un permalien vers un fichier dans un commit spécifique. comme le dit cette page help.github.

Pour toujours afficher la dernière image sur la branche des actifs, utilisez l'URL blob :

https://github.com/github/{repository}/blob/assets/cat.png 

(Extrait de la même page d'aide GitHub Les vues de fichiers montrent la dernière version d'une branche )

Answer 2

J'ai besoin d'inclure des images dans mon fichier README. Je ne sais pas comment comment le faire.

J'ai créé un petit assistant qui vous permet de créer et de personnaliser des galeries d'images simples pour le readme de votre dépôt GitHub : Voir ReadmeGalleryCreatorForGitHub .

L'assistant tire parti du fait que GitHub permet aux balises img de figurer dans le champ README.md . De plus, l'assistant utilise l'astuce populaire consistant à télécharger des images sur GitHub en les faisant glisser dans la zone de problème (comme cela a déjà été mentionné dans l'une des réponses de ce fil).

Answer 3

Engagez-vous votre image ( image.png ) dans un dossier ( monDossier ) et ajoutez la ligne suivante dans votre README.md :

![Optional Text](../master/myFolder/image.png)

Answer 4

Syntaxe de base

![myimage-alt-tag](url-to-image)

Ici :

1. my-image-alt-tag : texte qui sera affiché si l'image n'est pas affichée.
2. url-to-image : quelle que soit votre ressource image. URI de l'image

Exemple :

![stack Overflow](http://lmsotfy.com/so.png)

Cela ressemblera à ce qui suit :

Answer 5

• Créer un problème concernant l'ajout d'images

• Ajoutez l'image par glisser-déposer ou par le sélecteur de fichiers.

• Puis copier la source de l'image

• Maintenant, ajoutez ![alt tag](http://url/to/img.png) à votre fichier README.md

C'est fait !

Sinon, vous pouvez utiliser un site d'hébergement d'images tel que imgur pour obtenir son url et l'ajouter dans votre fichier README.md ou vous pouvez aussi utiliser un hébergement de fichiers statiques.

Exemple d'émission