La bonne solution est d'utiliser des références relatives, selon cette réponse stackoverflow.com/a/11916467/1633251 (voir le commentaire avec le lien vers un nouveau document github sur la façon de le faire). La réponse courte est d'utiliser[Read more words!](docs/more_words.md)
David H
2
La plupart des solutions proposent d'indiquer le dépôt lui-même. Qu'en est-il si vous voulez éviter les binaires dans le référentiel (même dans une branche séparée, comme proposé) et que vous souhaitez le stocker dans un endroit externe? Des bonnes pratiques? Un gist peut-être (IDK si gist peut être binaire ou simplement du texte)? créer un autre référentiel "myproject-assets" pour le projet "myproject"? Une place d'image populaire externe similaire à la norme de facto de YouTube pour le téléchargement de vidéos?
GitHub vous recommande d'utiliser des liens relatifs avec le ?raw=trueparamètre pour vous assurer que le point de dépôt forké est correctement.
Le raw=trueparamètre est là pour garantir que l'image à laquelle vous liez sera rendue telle quelle. Cela signifie que seule l'image sera liée à, pas toute l'interface GitHub pour ce fichier respectif. Voir ce commentaire pour plus de détails.
De plus, si vous créez une nouvelle branche screenshotspour stocker les images, vous pouvez éviter qu'elles ne soient dans l' masterarborescence de travail
Eh bien, j'ai ajouté les documents officiels sur les liens relatifs, mais je ne trouve pas de repo qui les utilise, si vous avez des suggestions, je serai heureux de vous aider car le but est d'aider plus de gens, pas de rester dans le champ d'application (mon erreur ici).
Quand vous dites /relative/path/to/img.jpg, n'est-ce pas un chemin absolu en raison de la barre oblique principale?
2017
1
@kelvin, le raw=trueparamètre est là pour rendre l'image vers laquelle le chemin GitHub pointe, pas l'interface GitHub. Essayez de voir la différence: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . La première URL vous montrera l'interface GitHub et l'image, tandis que la seconde ne vous montrera que l'image. Les liens relatifs sont toujours utiles lors du clonage / forking de repos, donc oui, vous devez utiliser des chemins relatifs avec ce paramètre, mais ce sont deux concepts différents.
Paul
70
Même s'il existe déjà une réponse acceptée, je voudrais ajouter une autre façon de télécharger des images dans le fichier Lisez-moi sur GitHub.
Vous devez créer un problème dans votre référentiel
Faites glisser et déposez dans la zone de commentaire votre image
Une fois le lien pour l'image généré, insérez-le dans votre fichier Lisez-moi
Je suis intéressé par la durée de vie des images chargées de cette façon. Github effectue-t-il un nettoyage des images? Comme, "si cette image ne fait référence à aucun problème de github, je peux la supprimer en toute sécurité" ...
artin
1
@Artin probablement uniquement lorsque le problème est complètement supprimé. Les problèmes fermés
persistent
55
J'ai trouvé que le chemin vers l'image dans mon repo ne suffisait pas, je devais faire un lien vers l'image sur le raw.github.comsous - domaine.
Format d'URL https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}
Exemple de démarque ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)
Dévaluer cela en raison du commentaire de @sorens sur la réponse acceptée. Il est mauvais de spécifier un bain absolu car cela ne fonctionnera pas bien sur les référentiels fourchus. (Ou si vous renommez votre dépôt, ou si github change de nom de domaine, etc., etc.)
Linus Unnebäck
7
@ LinusUnnebäck: Il y a une bonne raison d'utiliser des chemins absolus à mon humble avis: si le fichier readme.md est également utilisé dans d'autres endroits, par exemple, comme page principale de Doxygen. Les liens relatifs ne fonctionneront pas alors.
Ela782
1
@ Ela782 bien que, sur une autre note, cela ne devrait pas être un problème pour les logiciels qui extraient des fichiers README spécifiquement depuis GitHub ; ces logiciels doivent savoir résoudre correctement les URL relatives. npm le fait , par exemple.
Mark Amery
comment lier à l'image sur le raw.github.comsous-domaine? où télécharger le fichier image?
Saif
@Saif raw.github.com n'est qu'un reflet de ce qui est engagé dans votre référentiel github. Validez simplement l'image dans votre référentiel et suivez le format d'URL spécifié.
-1 pour la raison donnée par @ shaobin0604; les documents officiels recommandent d'utiliser des liens relatifs lors de la liaison à un fichier dans votre propre référentiel, afin que le lien pointe vers le bon endroit lorsqu'il est bifurqué.
Mark Amery
17
La syntaxe de démarque pour afficher des images est en effet:
![image](https://{url})
MAIS: Comment fournir le url?
Vous ne voulez probablement pas encombrer votre dépôt avec des captures d'écran, elles n'ont rien à voir avec le code
vous ne voudrez peut-être pas non plus gérer les tracas liés à la mise à disposition de votre image sur le Web ... (téléchargez-la sur un serveur ...).
Donc ... vous pouvez utiliser cette astuce géniale pour que github héberge votre fichier image. TDLR:
créer un problème sur la liste des problèmes de votre dépôt
faites glisser et déposez votre capture d'écran sur ce problème
copiez le code de démarque que github vient de créer pour que vous puissiez afficher votre image
collez-le sur votre fichier Lisez-moi (ou où vous voulez)
Alternativement, vous pouvez utiliser un site d'hébergement d'images comme imguret obtenir son URL et l'ajouter dans votre fichier README.md ou vous pouvez également utiliser un hébergement de fichiers statiques.
Tout d'abord, créez un répertoire (dossier) à la racine de votre référentiel local qui contiendra le fichier que screenshotsvous souhaitez ajouter. Appelons le nom de ce répertoire screenshots. Placez les images (JPEG, PNG, GIF, `etc.) que vous souhaitez ajouter dans ce répertoire.
Deuxièmement, vous devez ajouter un lien vers chaque image dans votre fichier README. Donc, si j'ai des images nommées 1_ArtistsActivity.pnget 2_AlbumsActivity.pngdans mon répertoire de captures d'écran, j'ajouterai leurs liens comme ceci:
Si vous souhaitez que chaque capture d'écran sur une ligne distincte, écrivez leurs liens sur des lignes distinctes. Cependant, il est préférable d'écrire tous les liens sur une seule ligne, séparés par un espace uniquement. Cela peut en fait ne pas sembler trop beau, mais ce faisant, GitHub les organise automatiquement pour vous.
Enfin, validez vos modifications et appuyez dessus!
Vous devez effectuer les substitutions réelles ci-dessus (par exemple, MY_IMAGE = image.jpg) pour que cela fonctionne.
Mais, attendez ... échec - il n'y a pas de véritable photo rendue! Et le lien est exactement comme indiqué par Google Storage!
Github camo- Images anonymes
Github héberge vos images de manière anonyme , yay! Cependant, cela pose un problème pour les ressources de stockage Google. Vous devez obtenir l'URL générée depuis votre console Google Cloud.
Je suis sûr qu'il existe un moyen plus simple, cependant, visitez simplement votre point de terminaison d'URL donné et copiez l'URL longue. Détails:
Cliquez sur l'image que vous souhaitez afficher dans Github (cela fait apparaître la page "Détails de l'objet")
Copiez les pâtes de cette URL (celle commençant par httpsnot gs) dans un nouvel onglet / fenêtre de navigateur
Copiez les pâtes la nouvelle URL générée - elle devrait être plus longue - de votre nouvel onglet / fenêtre de navigateur dans votre fichier Github README
J'espère que cela aidera à accélérer et à clarifier ce problème pour quiconque.
Pour info - Il semble que quelque chose change du côté de Google ou Github. J'ai eu quelques images dans les fichiers README qui échouaient via cette méthode, et certaines fonctionnaient à partir de l'après-midi du 28 mars 2020. YMMV ici!
Jason R Stevens CFA
0
Pour moi, le meilleur moyen est -
Créez un nouveau problème avec ce référentiel sur github, puis télé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/
Soumettez le problème nouvellement créé.
Copiez l'adresse du fichier téléchargé
Enfin dans votre fichier README mettez! [Démo] (ADRESSE COPIÉE)
Avec les images situées dans le /screen-shotsrépertoire. L'extérieur <div>permet de positionner les images. Le rembourrage est réalisé en utilisant <img width="desired-padding" height="0">.
[Read more words!](docs/more_words.md)
Réponses:
Si vous utilisez Markdown (README.md):
À condition que vous ayez l'image dans votre référentiel, vous pouvez utiliser une URL relative:
Si vous devez intégrer une image hébergée ailleurs, vous pouvez utiliser une URL complète
GitHub vous recommande d'utiliser des liens relatifs avec le
?raw=true
paramètre pour vous assurer que le point de dépôt forké est correctement.Le
raw=true
paramètre est là pour garantir que l'image à laquelle vous liez sera rendue telle quelle. Cela signifie que seule l'image sera liée à, pas toute l'interface GitHub 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 SVGs alors vous devrez définir l'attribut sanitize à
true
ainsi:?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émarque: http://daringfireball.net/projects/markdown/syntax
De plus, si vous créez une nouvelle branche
screenshots
pour stocker les images, vous pouvez éviter qu'elles ne soient dans l'master
arborescence de travailVous pouvez ensuite les intégrer en utilisant:
la source
/relative/path/to/img.jpg
, n'est-ce pas un chemin absolu en raison de la barre oblique principale?raw=true
paramètre est là pour rendre l'image vers laquelle le chemin GitHub pointe, pas l'interface GitHub. Essayez de voir la différence: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . La première URL vous montrera l'interface GitHub et l'image, tandis que la seconde ne vous montrera que l'image. Les liens relatifs sont toujours utiles lors du clonage / forking de repos, donc oui, vous devez utiliser des chemins relatifs avec ce paramètre, mais ce sont deux concepts différents.Même s'il existe déjà une réponse acceptée, je voudrais ajouter une autre façon de télécharger des images dans le fichier Lisez-moi sur GitHub.
Plus de détails que vous pouvez trouver ici
la source
J'ai trouvé que le chemin vers l'image dans mon repo ne suffisait pas, je devais faire 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 démarque
![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)
la source
raw.github.com
sous-domaine? où télécharger le fichier image?la source
Une ligne ci-dessous devrait être ce que vous recherchez
si votre fichier est dans le référentiel
si votre fichier est dans une autre URL externe
la source
La syntaxe de démarque pour afficher des images est en effet:
MAIS: Comment fournir le
url
?Donc ... vous pouvez utiliser cette astuce géniale pour que github héberge votre fichier image. TDLR:
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
la source
Beaucoup plus simple que d'ajouter une URL Téléchargez simplement une image dans le même référentiel, comme:
![Screenshot](screenshot.png)
la source
ajouter ceci à README
la source
Réduction:
![Screenshot](http://url/to/img.png)
Copiez ensuite la source de l'image
Maintenant, ajoutez
![Screenshot](http://url/to/img.png)
à votre fichier README.mdTerminé!
Alternativement, 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 également utiliser un hébergement de fichiers statiques.Exemple de problème
la source
Méthode 1-> Méthode Markdown
Méthode 2-> manière HTML
ou
Remarque -> Si vous ne souhaitez pas styliser votre image, c'est-à-dire redimensionner, supprimez la partie style
la source
Tout d'abord, créez un répertoire (dossier) à la racine de votre référentiel local qui contiendra le fichier que
screenshots
vous souhaitez ajouter. Appelons le nom de ce répertoirescreenshots
. Placez les images (JPEG, PNG, GIF, `etc.) que vous souhaitez ajouter dans ce répertoire.Capture d'écran d'Android Studio Workspace
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
et2_AlbumsActivity.png
dans mon répertoire de captures d'écran, j'ajouterai leurs liens comme ceci:Si vous souhaitez que chaque capture d'écran sur une ligne distincte, écrivez leurs liens sur des lignes distinctes. Cependant, il est préférable d'écrire tous les liens sur une seule ligne, séparés par un espace uniquement. Cela peut en fait ne pas sembler trop beau, mais ce faisant, GitHub les organise automatiquement pour vous.
Enfin, validez vos modifications et appuyez dessus!
la source
J'ai googlé quelques questions similaires et je n'ai vu aucune réponse à mon problème et à sa solution assez simple / facile.
Google Cloud Storage - une approche légèrement différente des images dans les fichiers README
Voilà: comme l'OP, je voulais une image dans mon Github README, et, connaissant la syntaxe Markdown pour le faire, je l'ai tapée:
Vous devez effectuer les substitutions réelles ci-dessus (par exemple, MY_IMAGE = image.jpg) pour que cela fonctionne.
Github
camo
- Images anonymesGithub héberge vos images de manière anonyme , yay! Cependant, cela pose un problème pour les ressources de stockage Google. Vous devez obtenir l'URL générée depuis votre console Google Cloud.
Je suis sûr qu'il existe un moyen plus simple, cependant, visitez simplement votre point de terminaison d'URL donné et copiez l'URL longue. Détails:
Instructions
https
notgs
) dans un nouvel onglet / fenêtre de navigateurJ'espère que cela aidera à accélérer et à clarifier ce problème pour quiconque.
la source
Pour moi, le meilleur moyen est -
J'espère que cela vous aidera.
la source
Ajouter une image dans le référentiel à partir de l'option de téléchargement de fichier puis dans le fichier README
la source
Avec les images situées dans le
/screen-shots
répertoire. L'extérieur<div>
permet de positionner les images. Le rembourrage est réalisé en utilisant<img width="desired-padding" height="0">
.la source