Vom Markdown zum anklickbaren Inhaltsverzeichnis
Der Generator liest die Überschriftenstruktur deines Dokuments aus und baut daraus verschachtelte Markdown-Links. So entsteht ein übersichtliches README-Inhaltsverzeichnis, ohne dass du Sprungmarken von Hand zusammensetzen musst.
Markdown-TOC in drei Schritten erstellen
Füge den Inhalt deiner .md-Datei links ein oder öffne eine lokale Markdown-Datei. Lege anschließend mit Ab Ebene und Bis Ebene fest, welche Überschriften von H1 bis H6 im Inhaltsverzeichnis erscheinen sollen.
Prüfe rechts in der Vorschau, ob Gliederung und Sprunglinks passen. Über das Kopiersymbol übernimmst du das fertige Markdown-Inhaltsverzeichnis und fügst es an der gewünschten Stelle in dein Dokument ein.
Markdown einfügen oder Datei öffnen
Der Generator erkennt ATX-Überschriften mit # ebenso wie Setext-Überschriften mit einer Unterstreichung aus === oder ---. Markdown in umzäunten Codeblöcken wird nicht als echte Gliederung behandelt. Die wichtigsten Schreibweisen findest du im Markdown-Spickzettel.
Überschriftenebenen auswählen
Für ein kompaktes README reichen häufig H2 bis H4. Bei längeren technischen Dokumentationen kannst du den Bereich passend zur vorhandenen Struktur erweitern.
TOC prüfen und kopieren
Die Vorschau zeigt das Inhaltsverzeichnis zusammen mit dem Dokument. So kannst du die Links testen, bevor du das Ergebnis übernimmst.
GitHub-README-Inhaltsverzeichnis erstellen
Ein sichtbares Inhaltsverzeichnis hilft Leserinnen und Lesern, in längeren README-Dateien direkt zu Installation, Konfiguration oder API-Referenz zu springen. Der Generator erstellt dafür eine verschachtelte Liste mit Ankerlinks im GitHub-Stil.
Wichtig ist die Unterscheidung: GitHub zeigt bei mehreren Überschriften zwar eine eigene Dokumentgliederung an, schreibt aber kein sichtbares TOC in den Text deiner README. Wenn das Inhaltsverzeichnis unmittelbar im Dokument stehen soll, kopierst du die generierte Markdown-Liste in die Datei. Das Verhalten der Dokumentgliederung und der Abschnittslinks beschreibt die offizielle GitHub-Dokumentation zu README-Dateien.
Ankerlinks bei Umlauten und doppelten Überschriften
Aus einer Überschrift wie ## Änderungen wird ein Linkziel wie #änderungen. Buchstaben und Ziffern bleiben erhalten, Satzzeichen entfallen und Leerzeichen werden durch Bindestriche ersetzt. Damit lassen sich auch deutschsprachige Überschriften natürlich abbilden.
Kommt dieselbe Überschrift mehrfach vor, erzeugt das Tool eindeutige Ziele mit einer fortlaufenden Endung. Im Beispiel werden zwei Abschnitte namens Häufige Fragen deshalb getrennt verlinkt.
Die Tabelle zeigt die Anker, die dieser Generator unmittelbar aus den aufgeführten Überschriften erzeugt. Sie dokumentiert die Regeln der Vorschau; auf einer anderen Zielplattform solltest du die Links zusätzlich im dortigen Renderer testen.
| Markdown-Überschrift | Kontext | Erzeugter Anker |
|---|---|---|
## Überblick | erstes Vorkommen | #überblick |
## Größe und Aufbau | erstes Vorkommen | #größe-und-aufbau |
## Installation & Einrichtung | Sonderzeichen entfällt | #installation--einrichtung |
## Fußnoten | ß bleibt erhalten | #fußnoten |
### Häufige Fragen | zweites Vorkommen | #häufige-fragen-1 |
GitHub-, GitLab- und andere Markdown-Anker
Der Generator verwendet GitHub-ähnliche Slugs und bietet derzeit keinen eigenen Modus für GitLab, MkDocs oder Obsidian. Die Vorschau prüft deshalb die von diesem Tool erzeugten Links, ist aber kein Kompatibilitätstest für den Renderer deiner Zielplattform.
GitLab unterstützt zusätzlich die speziellen Platzhalter [[_TOC_]] und [TOC]; Einzelheiten stehen in der offiziellen GitLab-Markdown-Dokumentation. Wenn du ein Inhaltsverzeichnis bei jeder Änderung automatisch aktualisieren möchtest, eignet sich eher eine Editor-Erweiterung wie Markdown All in One für VS Code oder ein CLI-Schritt.
Warum Markdown-Ankerlinks nicht funktionieren
Häufige Ursachen sind eine nachträglich geänderte Überschrift, eine abweichende Slug-Regel des Renderers, Satzzeichen oder unerwartete Endungen bei doppelten Überschriften. Erzeuge das Inhaltsverzeichnis nach jeder Änderung neu und prüfe das Ergebnis anschließend auf der Plattform, auf der du es veröffentlichst.
Mit dem Markdown-Link-Generator kannst du einzelne Sprungmarken kontrollieren; die Markdown-Live-Vorschau hilft beim Prüfen des gesamten Dokuments. Für eine Weitergabe als Office- oder Druckdatei beachte, dass ein Markdown-Linkverzeichnis nicht dasselbe ist wie ein natives Inhaltsverzeichnis in DOCX oder PDF.
Markdown bleibt in deinem Browser
Markdown-Text und lokale Dateien werden nicht zur Verarbeitung an unseren Server übertragen. Das ist besonders praktisch für interne Projektdokumentation, noch unveröffentlichte README-Dateien oder Notizen, die nicht für einen externen Upload bestimmt sind.
Deine Eingabe wird für die Dauer des aktuellen Tabs im Sitzungsspeicher deines Browsers (sessionStorage) auf deinem Gerät gespeichert. Dadurch bleibt sie nach einem Neuladen erhalten; wenn du den Tab schließt, endet diese Browsersitzung.
Enthält das Dokument externe Bilder, kann dein Browser diese jedoch direkt vom jeweiligen Bildserver laden. Dabei erhält der Anbieter technisch bedingt Verbindungsdaten wie deine IP-Adresse und Browserinformationen. Weitere Einzelheiten findest du in der Datenschutzerklärung. Eine Anmeldung oder Installation ist für den Generator nicht erforderlich.