680 votes

Comment ajouter une capture d'écran aux README dans un dépôt github ?

Est-il possible de placer une capture d'écran dans le fichier README d'un dépôt GitHub ? Quelle est la syntaxe ?

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

18voto

edelans Points 609

La syntaxe markdown pour l'affichage des images est en effet :

![image](https://{url})

MAIS : Comment fournir le url ?

  • Vous ne voulez probablement pas encombrer votre dépôt de captures d'écran, qui n'ont rien à voir avec le code.
  • vous ne voulez peut-être pas non plus vous embêter à rendre votre image disponible sur le web... (la télécharger sur un serveur... ).

Donc... vous pouvez utiliser ceci Une astuce géniale pour que github héberge votre fichier image. TDLR :

  1. créer un problème dans la liste des problèmes de votre dépôt.
  2. glisser et déposer votre capture d'écran sur cette question
  3. copier le code markdown que github vient de créer pour vous pour afficher votre image
  4. collez-le dans votre fichier readme (ou où vous voulez)

http://solutionoptimist.com/2013/12/28/awesome-github-tricks/

10voto

Taymour Niazi Points 61

Beaucoup plus simple que d'ajouter une URL Il suffit de télécharger une image dans le même référentiel, par exemple :

![Screenshot](screenshot.png)

8voto

Dan Alboteanu Points 1570

Ajouter ceci au README

<div align="center">
    <img src="/screenshots/screen1.jpg" width="400px"</img> 
</div>

6voto

abe312 Points 4155

Markdown : ![Screenshot](http://url/to/img.png)

  • 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 ![Screenshot](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 utiliser un hébergement de fichiers statiques.

Exemple d'émission

0 votes

J'ai fait cela il y a longtemps, maintenant les images ne sont pas disponibles. Je ne le recommande donc pas.

0 votes

Vous pouvez toujours utiliser imgur ou un autre cdn d'images personnalisé dans ce cas :)

6voto

shaurya uppal Points 542

Méthode 1>Markdown

![Alt Text](https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH})

Méthode 2->Méthode HTML

<img src="https://link(format same as above)" width="100" height="100"/>

ou

<img src="https://link" style=" width:100px ; height:100px " />

Note -> Si vous ne voulez pas donner un style à votre image, c'est-à-dire la redimensionner, supprimez la partie "style".

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