Est-il possible de placer une capture d'écran dans le fichier README d'un référentiel GitHub? Quelle est la syntaxe?
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")
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.
Plus de détails vous pouvez trouver ici
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)
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})
La syntaxe de démarquage pour l'affichage des images est en effet:
![image](https://{url})
MAIS: Comment fournir la url
?
Alors ... vous pouvez utiliser ceci astuce géniale pour que github héberge votre fichier image. TDLR:
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
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)
ajouter ceci à README
<div align="center">
<img src="/screenshots/screen1.jpg" width="400px"</img>
</div>
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.
Markdown: ![Screenshot](http://url/to/img.png)
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.
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!
Pour moi, le meilleur moyen est -
J'espère que cela aidera.