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

1007voto

Paul Punkte 18445

Wenn Sie Markdown (README.md) verwenden:

Vorausgesetzt, Sie haben das Bild in Ihrem Repository, können Sie eine relative URL verwenden:

![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")

Wenn Sie ein Bild einbetten müssen, das anderswo gehostet wird, können Sie eine vollständige URL verwenden

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

GitHub empfiehlt, dass Sie relative Links mit dem ?raw=true um sicherzustellen, dass geforkte Repos korrekt verweisen.

En raw=true dient dazu, sicherzustellen, dass das Bild, auf das Sie verlinken, so gerendert wird, wie es ist. Das bedeutet, dass nur das Bild verlinkt wird und nicht die gesamte GitHub-Schnittstelle für die jeweilige Datei. Siehe dieser Kommentar für weitere Einzelheiten.

Sehen Sie sich ein Beispiel an: https://raw.github.com/altercation/solarized/master/README.md

Wenn Sie SVGs verwenden, müssen Sie das Attribut sanitize auf true auch: ?raw=true&sanitize=true . (Danke @EliSherer)

Auch die Dokumentation über relative Links in README-Dateien: https://help.github.com/articles/relative-links-in-readmes

Und natürlich die Markdown-Dokumente: http://daringfireball.net/projects/markdown/syntax

Wenn Sie außerdem einen neuen Zweig erstellen screenshots um die Bilder zu speichern, können Sie vermeiden, dass sie in der master Arbeitsbaum

Sie können sie dann mit einbetten:

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

1 Stimmen

Nun, ich fügte die offiziellen Dokumente auf relative Links, aber ich bin nicht in der Lage, einige Repo, die sie verwendet, zu finden, wenn Sie Vorschläge haben, werde ich gerne helfen, da der ganze Punkt ist, mehr Menschen zu helfen, nicht in den Bereich (mein Fehler hier) zu bleiben.

2 Stimmen

@Paul , hier ist ein Beispiel für ein Repository, das genau das tut! github.com/Tarrasch/zsh-bd

0 Stimmen

Sie können das Bild auch mit einer anderen Stelle als der Rohbilddatei verknüpfen, indem Sie die folgende Syntax verwenden: [![Alt text](/path/to/img.jpg?raw=true)][http://example.com/]

87voto

Auch wenn es bereits eine akzeptierte Antwort gibt, möchte ich eine weitere Möglichkeit zum Hochladen von Bildern in Readme auf GitHub hinzufügen.

  • Sie müssen eine Ausgabe in Ihrem Repo erstellen
  • Ziehen Sie Ihr Bild per Drag and Drop in den Kommentarbereich
  • Nachdem der Link für das Bild erstellt wurde, fügen Sie ihn in Ihre Readme-Datei ein

Weitere Details finden Sie unter aquí

8 Stimmen

Ich bin gespannt, wie lange Bilder, die auf diese Weise geladen werden, überleben. Führt github eine Bereinigung der Bilder durch? Wie, "wenn dieses Bild nicht von einem Github Thema referenziert wird, kann ich es sicher entfernen"...

2 Stimmen

@Artin wahrscheinlich erst, wenn die Ausgabe vollständig gelöscht ist. Geschlossene Probleme bleiben für immer bestehen, da sie eine sehr wichtige Rolle bei der Dokumentation und Fehlersuche spielen

1 Stimmen

Der in dieser Antwort angegebene Hyperlink erscheint fragwürdig

56voto

Ryan Punkte 5266

Ich fand heraus, dass der Pfad zum Bild in meinem Repo nicht ausreichte, ich musste einen Link zum Bild auf der raw.github.com Subdomain.

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

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

5 Stimmen

Downvoting wegen @sorens Kommentar zur akzeptierten Antwort. Es ist schlecht, ein absolutes Bad anzugeben, da es bei geforketen Repositories nicht gut funktioniert. (Oder wenn Sie Ihr Repository umbenennen, oder wenn Github den Domainnamen ändert, usw. usw.)

10 Stimmen

@LinusUnnebäck: Es gibt imho einen guten Grund, absolute Pfade zu verwenden: Wenn die readme.md auch an anderen Stellen verwendet wird, zum Beispiel als Doxygen-Hauptseite. Relative Links werden dann nicht funktionieren.

2 Stimmen

@Ela782 obwohl, nebenbei bemerkt, das sollte kein Problem für Software, die README-Dateien rippt speziell von GitHub Eine solche Software sollte relative URLs richtig auflösen können. npm macht zum Beispiel.

55voto

diju Punkte 599

JUNI 3, 2020 : ARBEITSANTWORT-

  1. Laden Sie Ihr Bild hoch zu postimage.org
  2. Kopieren Github-Markdown-Url nach dem Hochladen des Bildes
  3. In Ihr ReadMe einfügen

4 Stimmen

Sie sind der Einzige, dessen Antwort für mich nützlich war

7 Stimmen

Das ist eine gute Antwort, aber seien Sie sich bewusst, dass Sie sich darauf verlassen, dass dieser Dienst für immer existiert. Es gibt keine Garantie, dass er nicht eines Tages verschwindet. Genauso wenig wie GitHub, aber es hängen genug wichtige Projekte und Leute davon ab, dass ich mich sicher fühle, dass ich zumindest Backups/Dumps bekomme, bevor es ausfällt. Außerdem weiß ich nicht, was in den Allgemeinen Geschäftsbedingungen steht, aber auch hier vertraue ich eher darauf, weil viel mehr Leute die AGB von GitHub durchgelesen haben.

1 Stimmen

...und auch wenn das Bild auf GitHub ist, werden das Bild und die Readme zusammen verschwinden.

25voto

mmcorrelo Punkte 900

Die folgende Zeile sollte die gesuchte sein

wenn sich Ihre Datei im Repository befindet

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

wenn Ihre Datei in einer anderen externen Url liegt

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

2 Stimmen

Schlagen vor, den relativen Link der Bilddatei zu verwenden, siehe Relative Links in READMEs - Github Hilfe

2 Stimmen

-1 aus dem von @shaobin0604 genannten Grund; die offiziellen Dokumente empfehlen, relative Links zu verwenden, wenn man auf eine Datei im eigenen Projektarchiv verlinkt, so dass der Link auf die richtige Stelle zeigt, wenn er geforkt wird.

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