README.md-Viewer und Vorschau

Prüfe eine README, bevor du sie pushst. Öffne die Datei, füge den Text ein oder lege einen GitHub-Link ab und sieh Badges, Tabellen, Codeblöcke, Aufgabenlisten, Hinweise und Mermaid-Diagramme so gerendert, wie GitHub sie zeigt.

README ansehen

Kostenlos · keine Anmeldung · läuft im Browser, nichts wird hochgeladen

Die markdown-it-README, geöffnet von einer GitHub-URL, gerendert mit Badges, Hinweisen und Code in GitHub Dark — Eine echte README direkt von einem GitHub-Link geöffnet: Badges, Hinweise, Tabellen und Code sehen aus wie auf GitHub.

Eine README von GitHub oder von der Festplatte öffnen

Füge eine GitHub-URL wie https://github.com/user/repo/blob/main/README.md in Öffnen → Von URL ein – der Viewer macht daraus den Link zur Rohdatei und rendert sie. Gist-Links funktionieren genauso. Für ein Projekt auf deinem Rechner lege die README.md auf der Seite ab oder füge ihren Inhalt in den Editor ein.

Alles, was GitHub rendert, genauso gerendert

GitHub-Flavored Markdown ist ein bestimmter Dialekt, und READMEs stützen sich auf seine Extras: Pipe-Tabellen, - [ ]-Aufgabenlisten, ~~durchgestrichen~~, automatisch verlinkte URLs, > [!NOTE]- / [!WARNING]-Hinweise, <details>-Abschnitte für lange Installationsanleitungen, shields.io-Badges, relative Überschriftenanker und eingezäunten Code mit Sprachlabels. All das wird hier gerendert, mit denselben Überschriften-IDs, die GitHub erzeugt, sodass deine Links innerhalb der Seite weiter funktionieren. Mermaid-Diagramme – die GitHub ebenfalls zeichnet – werden auch gerendert.

Vor dem Commit korrigieren

Wechsle in die geteilte Ansicht und bearbeite die README mit Live-Vorschau: Die Werkzeugleiste fügt Tabellen und Aufgabenlisten ein, Tastenkürzel übernehmen fett, Links und Überschriften, und die Gliederung zeigt, ob sich deine Abschnittsstruktur gut liest. Lade die .md herunter, wenn sie passt, oder kopiere das gerenderte HTML für eine Projektseite. Eine README ist nicht die einzige Markdown-Datei in einem Repository: Anweisungsdateien wie CLAUDE.md und AGENTS.md lassen sich genauso öffnen – siehe den CLAUDE.md-Viewer.

In Aktion

Note-, Important-, Warning- und Caution-Hinweise im GitHub-Stil, ein Zitat und ein aufklappbarer details-Abschnitt im Theme GitHub Dark — Hinweise im GitHub-Stil, Zitate und aufklappbare <details>-Abschnitte, in GitHub Dark.

Syntaxhervorgehobene TypeScript-, Python-, Bash- und diff-Codeblöcke mit Sprachlabels und Kopierbuttons — Codeblöcke bekommen ein Sprachlabel, Syntaxhervorhebung für über 50 Sprachen und einen Kopierbutton – hier das Theme One Dark.

KaTeX-Formel im Display-Modus und ein Mermaid-Flussdiagramm, gerendert in der Vorschau — KaTeX-Formeln und Mermaid-Flussdiagramme werden direkt im Dokument gerendert.

So funktioniert es

1
Füge einen GitHub-README-Link in Öffnen → Von URL ein oder lege die Datei auf der Seite ab.
2
Lies sie gerendert, mit Badges, Tabellen, Code und Diagrammen an Ort und Stelle.
3
Bearbeite sie in der geteilten Ansicht und lade dann die aktualisierte README.md herunter.

Was du bekommst

GitHub-Links, umgewandelt

blob- und Gist-URLs werden automatisch zu Rohdateien.

GFM komplett

Tabellen, Aufgabenlisten, Hinweise, Fußnoten, details, Badges, Autolinks, Emoji.

Mermaid-Diagramme

Architektur- und Flussdiagramme werden an Ort und Stelle gerendert.

Dunkle und helle Themes

Prüfe, wie sich die README in GitHub Dark und in Light liest.

Mit Vorschau bearbeiten

Formatierungsprobleme beheben und die korrigierte Datei herunterladen.

Privat

Lokale Dateien verlassen nie deinen Browser; URL-Abrufe werden nicht gespeichert.

Häufige Fragen

Sieht es identisch zu GitHub aus?

Die Markdown-Regeln und Überschriften-IDs entsprechen GitHub-Flavored Markdown, und die Themes GitHub Light / Dark verwenden die Farben von GitHub. Kleine Abstandsunterschiede sind möglich, aber Struktur, Tabellen, Code und Hinweise werden gleich gerendert.

Kann ich die README eines privaten Repositorys ansehen?

Nicht per URL, da sich der Server nicht bei GitHub anmelden kann. Lade die Datei stattdessen herunter und lege sie auf der Seite ab – sie bleibt auf deinem Gerät.

Funktionieren relative Bildlinks?

Bilder mit absoluten URLs werden gerendert. Relative Pfade wie docs/logo.png lassen sich für eine lokale Datei nicht auflösen; beim Öffnen von einer GitHub-URL verwende raw.githubusercontent.com-Pfade.

Werden Badges angezeigt?

Ja. Badges sind gewöhnliche Bilder mit absoluten URLs und werden normal gerendert.

Kann ich eine README von einer anderen Seite als GitHub rendern?

Ja, jede öffentliche URL, die eine Markdown-Datei zurückgibt, funktioniert. HTML-Seiten werden abgelehnt, damit du weißt, dass du den Raw-Link verwenden musst.

Bereit, wenn du es bist

Markdown einfügen, eine Datei ablegen oder eine URL öffnen – die Vorschau erscheint sofort und alles bleibt auf deinem Gerät.

Markdown Viewer öffnen