734 Stimmen

Wie füge ich einen Screenshot zu den READMEs im Github-Repository hinzu?

Ist es möglich, einen Screenshot in der README-Datei in einem GitHub-Repository zu platzieren? Wie lautet die Syntax?

3 Stimmen

Die korrekte Lösung für dieses Problem ist die Verwendung relativer Referenzen, wie in dieser Antwort beschrieben stackoverflow.com/a/11916467/1633251 (siehe den Kommentar mit dem Link zu einem neuen Github-Dokument, wie man das macht). Die kurze Antwort ist, zu verwenden [Read more words!](docs/more_words.md)

4 Stimmen

Die meisten Lösungen schlagen einen Verweis auf das Repo selbst vor. Wie sieht es aus, wenn man Binärdateien im Repo vermeiden möchte (sogar in einem separaten Zweig, wie vorgeschlagen) und sie an einem externen Ort speichern möchte? Irgendwelche guten Praktiken? Ein Gist vielleicht (ich weiß nicht, ob ein Gist binär oder nur Text sein kann)? ein weiteres Repo "myproject-assets" für das Projekt "myproject" erstellen? Gibt es einen externen populären Ort für Bilder, ähnlich dem de-facto-Standard von youtube für das Hochladen von Videos?

3 Stimmen

6voto

abe312 Punkte 4455

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

  • Erstellen Sie ein Problem beim Hinzufügen von Bildern

  • Fügen Sie das Bild durch Ziehen und Ablegen oder über die Dateiauswahl hinzu

  • Dann Bildquelle kopieren

  • Jetzt hinzufügen ![Screenshot](http://url/to/img.png) zu Ihrer README.md-Datei

Erledigt!

Alternativ können Sie auch eine Bildhosting-Website wie imgur und fügen Sie die URL in Ihre README.md-Datei ein. Sie können auch ein statisches Dateihosting verwenden.

Beispielhafte Ausgabe

0 Stimmen

Ich habe dies vor langer Zeit getan, jetzt sind die Bilder nicht mehr verfügbar. Ich empfehle dies also nicht.

0 Stimmen

Du könntest in diesem Fall immer imgur oder ein anderes benutzerdefiniertes Bild-CDN verwenden :)

4voto

R Holmes Punkte 51

Hinzufügen ![ScreenShot](screenshot.png) in der Readme-Datei, wie bereits von vielen erwähnt. Ersetzen Sie screenshot.png durch den Namen des Bildes, das Sie in Ihr Repository hochgeladen haben.

Aber hier ist ein Tipp für Anfänger, wenn Sie das Bild hochladen (da ich diesen Fehler selbst gemacht habe):

Stellen Sie sicher, dass Ihr Bildname keine Leerzeichen enthält. Mein Originalbild wurde als "Screenshot Tag Monat Jahr id.png" gespeichert. Wenn Sie den Namen nicht in etwas wie "contentofimage.png" ändern, wird das Bild nicht in Ihrer Readme-Datei erscheinen.

0 Stimmen

Die mit Abstand einfachste Methode! Ich wollte diesen Eintrag gerade selbst vornehmen, als ich weit genug unten las, um diese ausgezeichnete Antwort zu sehen. Ich durfte nur einmal hochstimmen.

4voto

Indrajeet Gour Punkte 3262

Für mich hat sich der relative Pfad sehr gut bewährt.

Wie ich das gemacht habe: In meiner aktuellen md-Datei, in der ich ein Bild aus einem anderen Verzeichnis verwenden wollte, habe ich einen relativen Pfad wie diesen verwendet - beachten Sie die folgenden Punkte.

md file loc: base dir -> _post -> current_file.md

& Bilddatei loc, die ich verwenden wollte: base dir -> _asset -> picture_to_use.jpeg

Die Erklärung, die ich verwendet habe, lautete current_file.md Datei:

![your-pic-caption-name](../_asset/picture_to_use.jpeg)

Hinweis - vorher habe ich direkte _asset aber im Idealfall geht es so aus ../_asset/and-so-no

Hinweis - https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-readmes

2voto

Ich habe ein paar ähnliche Fragen gegoogelt und keine Antworten zu meinem Problem gefunden, und es ist eine recht einfache Lösung.

Google Cloud Storage - ein etwas anderer Ansatz für Bilder in READMEs

Hier geht: wie die OP, ich wollte ein Bild in meinem Github README, und, wissen die Markdown-Syntax für dies zu tun, tippte es in:

![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}

Damit dies funktioniert, müssen Sie die oben genannten Ersetzungen vornehmen (z. B. MY_IMAGE=image.jpg).

Aber, Moment... Fehlschlag - es gibt kein aktuelles gerendertes Foto! Und der Link ist genau so, wie er von Google Storage angegeben wurde!

screenshot of failed Github image upload

Github camo - Anonyme Bilder

Github hostet Ihre Bilder anonym juhu! Dies stellt jedoch ein Problem für Google-Speicherressourcen dar. Sie müssen die generierte Url von Ihrer Google Cloud Console abrufen.

Ich bin sicher, dass es einen einfacheren Weg gibt, aber besuchen Sie einfach den angegebenen URL-Endpunkt und kopieren Sie die lange URL. Einzelheiten:

Anweisungen

  1. Besuchen Sie Ihre Speicherkonsole: https://console.cloud.google.com/storage/browser/ ${MY_BUCKET}?project=${MY_PROJECT}
  2. Klicken Sie auf das Bild, das Sie in Github anzeigen möchten (dadurch wird die Seite "Objektdetails" aufgerufen)
  3. Kopieren Sie diese URL (diejenige, die mit https pas gs ) in einer neuen Browser-Registerkarte/einem neuen Browser-Fenster
  4. Kopieren Sie die neu generierte URL - sie sollte länger sein - von Ihrem neuen Browser-Tab/Fenster in Ihre Github README-Datei

Ich hoffe, dass dies zur Beschleunigung und Klärung dieses Problems für alle anderen beiträgt.

0 Stimmen

FYI - Es scheint, dass sich auf der Google- oder Github-Seite etwas ändert. Ich hatte einige Bilder in READMEs, die mit dieser Methode fehlgeschlagen sind, und einige, die seit dem Nachmittag des 28. März 2020 funktionieren. YMMV hier!

2voto

Rohullah Nabavi Punkte 72

Bitte beachten Sie diese vier Schritte, das hat bei mir funktioniert

1-Erstellen Sie einen neuen Eintrag auf GitHub. 2-Ziehen Sie ein Bild in das Kommentarfeld oder laden Sie ein Foto hoch. 3-Warten Sie, bis der Hochladevorgang abgeschlossen ist. 4-Kopieren Sie die URL und verwenden Sie sie in Ihren Markdown-Dateien auf GitHub (verwenden Sie die generierte URL in der Readme-Datei Ihres Repositorys).

1 Stimmen

Am besten fügen Sie es einfach zu Ihrem Repo hinzu, nicht indirekt über einen Upload aus einer Ausgabe. Auf diese Weise kann es versioniert und im Laufe der Zeit auch leichter geändert werden.

CodeJaeger.com

CodeJaeger ist eine Gemeinschaft für Programmierer, die täglich Hilfe erhalten..
Wir haben viele Inhalte, und Sie können auch Ihre eigenen Fragen stellen oder die Fragen anderer Leute lösen.

Powered by:

X