web-dev-qa-db-fra.com

Comment ajouter une capture d'écran aux fichiers README dans le référentiel github?

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

538
daisy

Si vous utilisez Markdown (README.md):

Si vous avez l'image dans votre rapport, 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 des liens relatifs avec le paramètre ?raw=true pour vous assurer que le pointage des retraits avec fourches est correct.

Le paramètre raw=true est présent afin de garantir que l'image à laquelle vous créez un lien sera rendue telle quelle. Cela signifie que seule l'image sera liée, pas l'interface GitHub entière pour ce fichier respectif. Voir ce commentaire pour plus de détails.

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

Si vous utilisez des SVG, vous devrez alors définir l'attribut sanitize sur true: ?raw=true&sanitize=true. (Merci @EliSherer)

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 de démarques: http://daringfireball.net/projects/markdown/syntax

De plus, si vous créez une nouvelle branche screenshots pour stocker les images, vous pouvez les éviter dans l’arborescence de travail master.

Vous pouvez ensuite les intégrer en utilisant:

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

Même s'il existe déjà une réponse acceptée, j'aimerais ajouter un autre moyen de télécharger des images à lire sur GitHub.

  • Vous devez créer un problème dans votre rapport
  • Glissez-déposez dans la zone de commentaire votre image
  • Une fois le lien généré pour l'image, insérez-le dans votre fichier Lisez-moi.

Plus de détails vous pouvez trouver ici

62
user3941146

J'ai trouvé que le chemin d'accès à l'image dans mon référentiel ne suffisait pas, je devais créer un lien vers l'image du sous-domaine raw.github.com.

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

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

54
Ryan

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

si votre fichier est dans le référentiel

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

si votre fichier est dans une autre URL externe

![ScreenShot](https://{url})
20
mmcorrelo
  1. Téléchargez votre image sur postimage.org
  2. Obtenir l'URL de github markdown
  3. Insérer dans votre Readme
18
diju

La syntaxe de démarquage pour l'affichage des images est en effet:

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

MAIS: Comment fournir la url?

  • Vous ne voulez probablement pas encombrer votre repo avec des captures d'écran, elles n'ont rien à voir avec le code
  • vous ne voudrez peut-être pas non plus vous soucier de rendre votre image disponible sur le Web ... (téléchargez-la sur un serveur ...).

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

  1. créer un problème sur la liste de problèmes de votre rapport
  2. glissez et déposez votre capture d'écran sur cette question
  3. copiez 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/

16
edelans

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)

6
Taymour Niazi

ajouter ceci à README

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

Méthode 1-> Méthode de démarque

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

Méthode 2 -> 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 souhaitez pas attribuer de style à votre image, redimensionner, supprimez la partie de style.

4
shaurya uppal

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 sélecteur de fichier
  • Puis copiez la source de l'image

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

Terminé!

Sinon, vous pouvez utiliser un site d'hébergement d'images tel que imgur et obtenir son adresse URL et l'ajouter à votre fichier README.md ou vous pouvez également utiliser un hébergement de fichiers statiques.

Exemple de numéro

3
abe312

Commencez par créer un répertoire (dossier) à la racine de votre référentiel local qui contiendra le screenshots à ajouter. Appelons le nom de ce répertoire screenshots. Placez les images (JPEG, PNG, GIF, `etc.) que vous souhaitez ajouter dans ce répertoire.

Capture d'écran de l'espace de travail Android Studio

Deuxièmement, vous devez ajouter un lien vers chaque image dans votre fichier README. Donc, si j'ai des images nommées 1_ArtistsActivity.png et 2_AlbumsActivity.png dans le répertoire de mes captures d'écran, j'ajouterai leurs liens comme suit:

 <img src="screenshots/1_ArtistsActivity.png" height="400" alt="Screenshot"/> <img src=“screenshots/2_AlbumsActivity.png" height="400" alt="Screenshot"/>

Si vous voulez chaque capture d'écran sur une ligne distincte, écrivez leurs liens sur des lignes séparées. Toutefois, il est préférable d’écrire tous les liens sur une seule ligne, séparés par un espace uniquement. Cela n’a peut-être pas l'air très beau, mais GitHub les arrange automatiquement pour vous.

Enfin, validez vos modifications et appuyez dessus!

2
Zizoh

Pour moi, le meilleur moyen est -

  1. Créez un nouveau numéro avec ce référentiel sur github puis chargez le fichier au format gif. Pour convertir des fichiers vidéo au format gif, vous pouvez utiliser ce site Web http://www.online-convert.com/
  2. Soumettez le problème nouvellement créé.
  3. Copier l'adresse du fichier téléchargé
  4. Enfin dans votre fichier README put! [Demo] (ADRESSE COPIÉE)

J'espère que cela aidera.

0
Asifur Rahman