Mit diesem README-Editor schreibst du README.md-Dateien mit Live-Vorschau im GitHub-Stil, anklickbarem Inhaltsverzeichnis, Aufgabenlisten, Tabellen und Codeblöcken. Starte mit der Beispiel-README, formatiere per Werkzeugleiste oder Tastenkürzel und lade die .md-Datei oder eine eigenständige HTML-Seite herunter. Dein Entwurf wird beim Tippen im Browser gespeichert.
Anleitung
- Markdown im Editor schreiben oder eine .md-Datei ablegen, öffnen oder einfügen. Zum Start ist eine Beispiel-README geladen.
- Über die Leiste oder Tastenkürzel: fett, kursiv, Überschriften, Links, Listen, Aufgaben, Code, Zitate und Tabellen.
- In der Vorschau siehst du das Ergebnis im GitHub-Stil mit klickbarem Inhaltsverzeichnis, unter HTML den erzeugten Code.
- HTML kopieren, eine eigenständige .html-Seite mit Styles herunterladen oder die .md-Datei speichern.
- Unterstützt GitHub Flavored Markdown: Tabellen, Aufgabenlisten, Codeblöcke, Durchstreichen und Autolinks. Überschriften bekommen Anker-IDs wie auf GitHub.
- Das HTML wird bereinigt: Skripte und unsichere Attribute werden entfernt.
- Dein Entwurf wird automatisch in diesem Browser gespeichert und ist beim nächsten Besuch noch da.
- Auf breiten Bildschirmen zeigt „Geteilt“ Editor und Vorschau nebeneinander.
Was in eine gute README gehört
Die README ist das Erste, was man in einem Repository sieht, und sollte drei Fragen schnell beantworten: Was macht das Projekt, wie installiert man es, wie benutzt man es. Eine übliche Reihenfolge ist eine Einzeiler-Beschreibung, ein kurzes Beispiel oder Screenshot, Installation, Nutzung mit Codeblock, Konfiguration, Mitwirken und Lizenz. Halte den ersten Absatz frei von Fachjargon; Details kommen weiter unten.
Codeblöcke mit Sprachangabe (```js, ```bash) bekommen auf GitHub Syntaxhervorhebung. Relative Links wie docs/setup.md funktionieren innerhalb des Repositorys, Bilder können auf Dateien darin verweisen.
GitHub Flavored Markdown
Die Vorschau folgt GitHub Flavored Markdown (GFM), einer Erweiterung des CommonMark-Standards. Zusätzlich zu Überschriften, Listen, Links und Hervorhebungen gibt es Tabellen mit senkrechten Strichen, Aufgabenlisten mit - [ ] und - [x], ~~Durchstreichen~~, automatische Links für nackte URLs und umzäunte Codeblöcke. Jede Überschrift erhält eine Anker-ID im GitHub-Stil, sodass ein Link wie #installation zu diesem Abschnitt springt; genau das nutzt das Inhaltsverzeichnis.
Häufige Fragen
Wie füge ich einer README ein Inhaltsverzeichnis hinzu?
Füge eine Liste mit Links auf die Anker der Überschriften ein, etwa - [Nutzung](#nutzung); GitHub löst sie wie die Vorschau auf. Das anklickbare Inhaltsverzeichnis der Vorschau zeigt jede Überschrift samt Anker.
Wie erstelle ich eine Aufgabenliste?
Eine Zeile mit - [ ] für eine offene oder - [x] für eine erledigte Aufgabe beginnen. Auf GitHub lassen sich Aufgabenlisten in Issues und Pull Requests direkt abhaken.
Werden GitHub-Tabellen und Codeblöcke unterstützt?
Ja. Tabellen trennen Spalten mit | und haben unter der Kopfzeile eine Zeile aus Bindestrichen; Codeblöcke beginnen und enden mit drei Backticks.
Wird mein Entwurf gespeichert?
Ja, automatisch in diesem Browser, und er ist beim nächsten Besuch noch da. Hochgeladen wird nichts.
Kann ich das HTML bekommen?
Ja. In der HTML-Ansicht kopierst du das erzeugte, bereinigte Markup oder lädst eine eigenständige, gestaltete .html-Seite herunter.