66 votes

L'image ne s'affiche pas dans le fichier README.md sur GitHub

J'essaie d'ajouter une image à l README.md dans mon dépôt en utilisant le markdown ci-dessous :

![ScreenShot](https://github.com/i-saumitra/Voice-controlled-MP3-Player/blob/master/screenshot.jpg)

Mais l'image ne s'affiche pas lorsque je visite mon référentiel. C'est le lien vers l'image qui s'affiche. En cliquant sur le lien, l'image s'ouvre dans une nouvelle fenêtre.

J'ai également essayé d'utiliser un chemin relatif :

![ScreenShot](screenshot.jpg)

Mais cela donne une erreur de page non trouvée.

Quel est le bon langage de balisage pour afficher une image dans le texte suivant README.md

Les deux sites README.md et le fichier image sont dans le même chemin/répertoire.

Quelle est la manière correcte d'afficher une image dans le fichier README.md de github ?

Le contenu complet du fichier README.md est le suivant :

Voice-controlled-MP3-Player
===========================

A MP3 player which accept voice command like PLAY, PAUSE, FORWARD, etc. Using C# and Microsoft Speech API.

![ScreenShot](https://github.com/i-saumitra/Voice-controlled-MP3-Player/blob/master/screenshot.jpg)

0 votes

0 votes

Tout à coup, ce "problème" a refait surface. Les images qui étaient rendues auparavant n'apparaissent pas. Ce n'est pas seulement dans mon dépôt mais dans d'autres aussi. Que se passe-t-il ?

0 votes

Ne vous inquiétez pas ! Ils semblent fonctionner maintenant... J'ai même fait un problème sur un autre repo ! github.com/arshadkazmi42/first-issues/issues/87

89voto

nulltoken Points 15605

Contenu actualisé

Depuis le 30 janvier 2013, GitHub prend en charge les liens relatifs dans les documents de balisage.

Cela signifie que votre code ![ScreenShot](screenshot.jpg) fonctionne désormais sans problème.

Comme l'a souligné @Brad, cela peut également faciliter un scénario où les images sont différentes dans deux branches, mais portent la même chose. Dans ce cas, en passant d'une branche à l'autre, on changerait dynamiquement l'image dans la vue rendue, sans qu'il soit nécessaire de modifier le contenu du Readme.

Réponse précédente lorsque GitHub ne prenait pas en charge les liens relatifs

Vous devez utiliser le format url brut. Dans votre cas, ce serait https://raw.githubusercontent.com/i-saumitra/Voice-controlled-MP3-Player/master/screenshot.jpg

Cela signifie que la démarque correcte serait la suivante

![ScreenShot](https://raw.githubusercontent.com/i-saumitra/Voice-controlled-MP3-Player/master/screenshot.jpg)

En l'utilisant dans un .md sur github affichera l'image suivante ;-)

ScreenShot

Mise à jour suite à votre commentaire

où est-ce que c'est officiellement documenté que nous devons utiliser du brut... je n'ai pas pu le trouver n'importe où

Ce format d'URL est une caractéristique non documentée du site GitHub. Cela signifie qu'il pourrait changer ultérieurement. Si cela se produit, pour "redécouvrir" le nouveau format, cliquez sur l'icône Brut lors de l'affichage d'une image. Cela va "ouvrir" l'image dans votre navigateur. Copiez l'URL et voilà !

raw

Note : Bien que le référentiel ne soit plus hébergé sur GitHub, j'ai mis à jour les urls pour refléter le nouveau Politique de GitHub concernant le contenu des utilisateurs

11 votes

Pour les autres qui trouvent cela, Github prend désormais en charge les liens relatifs : help.github.com/articles/relative-links-in-readmes

1 votes

Ce n'est plus une bonne solution. GitHub prend désormais en charge la liaison à une image avec un chemin relatif : ![alt text](doc/image.png) L'avantage ici est que vous pouvez utiliser d'autres branches et savoir que vous avez la bonne version des images dans votre documentation.

0 votes

@Brad Je stocke les images dans un fichier assets et j'ai des problèmes pour faire fonctionner les chemins relatifs à la fois dans le README de GitHub et dans le fichier README local. Veuillez consulter cette question

40voto

bosky101 Points 301

Vous devriez vraiment utiliser des urls relatives. De cette façon, elles fonctionneront mieux pour les dépôts privés également.

![ScreenShot](/screenshots/latest.png)

en supposant que votre repo a latest.png dans le dossier screenshots.

~B

1 votes

Je suis d'accord, il est préférable de le rendre relatif à une image dans le repo :-)

1 votes

Il est particulièrement vrai que Github change occasionnellement le chemin du fichier brut, notamment récemment de " github.com/user-name/repo-name/raw " à " raw.githubusercontent.com/nom-de-l'utilisateur/nom-du-repo- ". Utilisez des chemins relatifs afin de ne pas avoir à vérifier souvent si les liens vers les images de votre dépôt sont cassés.

0 votes

Vous pouvez également utiliser <img src="../<branch>/screenshot.jpg?raw=true" width="100" height="100" /> Si vous souhaitez prendre en charge le support rétina en fournissant une image qui est par exemple de 200*200px ;)

18voto

Rakesh Yembaram Points 83

Pour que les URL relatives fonctionnent avec les images, il faut les placer à l'intérieur de la balise paragraphe.

J'étais confronté à ce problème, surtout lorsque je travaillais avec une seule image.

Ejemplo:

<p>
    <img src="relativePath/file.png" width="220" height="240" />
</p>

6voto

Josh Mitton Points 101

Une extension aux réponses précédentes...

L'image ne s'affichait pas pour moi lorsque la ligne :

![ScreenShot](/image.png)

était juste en dessous d'un <h2></h2> et je devais ajouter une ligne vide entre elles.

J'espère que cela fera gagner du temps à quelqu'un !

0 votes

C'était la même chose pour moi. Assurez-vous que vous avez une ligne vide au-dessus de l'extrait de code spécifiant l'image.

3voto

Amanda Points 31

J'ai pensé que je mettrais cela à jour pour 2019 car j'ai eu du mal à comprendre cela pour moi-même. J'ai téléchargé mes images dans un repo sur GitHub, puis j'ai utilisé l'url brute de l'image pour l'importer dans mon fichier markdown. Pour obtenir l'url brute, cliquez sur le lien de l'image spécifique dans GitHub afin d'être sur la page de cette image spécifique. En haut à droite de la photo, il y a deux boutons, "Télécharger" et "Historique". Si vous cliquez sur "Télécharger", vous accédez à l'url brute avec la photo en plein écran. Copiez cette url, puis collez-la comme ceci dans votre fichier markdown :

![image description or alt text](https://raw.githubusercontent.com/i-saumitra/Voice-controlled-MP3-Player/master/screenshot.jpg)

Le bouton indiquait "Raw" et non "Download". J'espère que cela aidera les gens à le trouver.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X