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


Est-il possible de placer une capture d'écran dans le fichier README dans un référentiel GitHub? Quelle est la syntaxe?


495
2018-04-17 10:20


origine


Réponses:


Si vous utilisez Markdown (README.md):

Pourvu que vous ayez l'image dans votre repo, 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 une URL complète

![Alt text](http://full/path/to/img.jpg "Optional title")

GitHub vous recommande d'utiliser liens relatifs avec le ?raw=true paramètre pour assurer le point de repos fourchue correctement.

Découvrez un exemple: https://raw.github.com/altercation/solarized/master/README.md

En outre, la documentation sur les liens relatifs dans les fichiers README: https://help.github.com/articles/relative-links-in-readmes

Et bien sûr, les documents markdown: http://daringfireball.net/projects/markdown/syntax

En outre, si vous créez une nouvelle branche screenshots pour stocker les images, vous pouvez les éviter d'être dans le master arbre de travail

Vous pouvez ensuite les intégrer en utilisant:

![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")

710
2018-04-17 10:22



Même s'il existe déjà une réponse acceptée, je souhaiterais ajouter une autre façon de télécharger des images à lire sur GitHub.

  • Vous devez créer un problème dans votre repo
  • Faites glisser et déposez dans la zone de commentaire votre image
  • Après le lien pour l'image est générée insérez-le dans votre readme

Plus de détails vous pouvez trouver ici


54
2017-07-21 03:15



J'ai trouvé que le chemin de l'image dans mon repo ne suffisait pas, j'ai dû créer un lien vers l'image sur le raw.github.com sous-domaine.

Format d'URL https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

Exemple de Markdown ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)


48
2017-10-21 11:47



Une ligne ci-dessous devrait être ce que vous cherchez

si votre fichier est dans le dépôt

![ScreenShot](https://raw.github.com/{username}/{repository}/{branch}/{path})

si votre fichier est dans une autre URL externe

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

20
2018-05-26 20:09



  1. Téléchargez votre image sur postimage.org
  2. Obtenez l'URL de Markdown de github
  3. Insérer dans votre fichier ReadMe

17
2017-11-18 19:33



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 repo avec des screenshots, ils n'ont rien à voir avec le code
  • vous ne voudrez peut-être pas non plus vous occuper de rendre votre image disponible sur le Web ... (téléchargez-la sur un serveur ...).

Alors ... tu peux utiliser ça super tour Github héberger votre fichier image. TDLR:

  1. créer un problème sur la liste des numéros de votre dépôt
  2. faites glisser et déposez votre capture d'écran sur ce problème
  3. copier le code de démarquage que github vient de créer pour vous pour afficher votre image
  4. Collez-le sur votre readme (ou où vous voulez)

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


13
2017-08-27 14:50



ajouter ceci au fichier README

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

5
2018-03-08 17:16



Réduction:  ![Screenshot](http://url/to/img.png)

  • Créer un problème concernant l'ajout d'images
  • Ajouter l'image par glisser-déposer ou par sélecteur de fichier
  • Ensuite, copiez la source d'image

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

Terminé!

Sinon, vous pouvez utiliser un site d'hébergement d'images comme imgur et obtenir son URL et l'ajouter dans votre fichier README.md ou vous pouvez utiliser un hébergement de fichier statique aussi.

Exemple de problème


3
2017-10-12 19:16