Noch keine Eingabe.
Inhaltsverzeichnis mit GitHub-Ankern
Mit diesem Tool lässt sich ein Markdown-Inhaltsverzeichnis aus den Überschriften eines Dokuments erstellen – mit Ankerlinks, die zu GitHub und GitLab passen. README einfügen und die Liste kopieren oder das ganze Dokument mit eingefügtem Verzeichnis herunterladen.
Zuletzt aktualisiert:
So funktioniert’s
Markdown einfügen
README einfügen, eine .md-Datei über „Datei öffnen“ wählen oder „Von URL öffnen“ nutzen. Überschriften in Codeblöcken und HTML-Kommentaren werden übersprungen.
Ebenen und Stil festlegen
Unter „Von“ und „Bis“ die Überschriftenebenen bestimmen, dazu „Listenstil“, „Einrückung“ und „Anker“ (GitHub, GitLab oder „Ohne Links“).
Kopieren oder einfügen
Im Reiter „Verzeichnis“ nur die Liste kopieren oder im Reiter „Dokument mit Verzeichnis“ die ganze Datei übernehmen: Das Verzeichnis steht zwischen <!-- toc -->-Markierungen, ein vorhandener Block wird ersetzt.
Funktionen
Anker wie auf GitHub
Die Anker folgen github-slugger: Kleinschreibung, Satzzeichen entfernt, Leerzeichen zu Bindestrichen. Gleichlautende Überschriften erhalten -1, -2 über die ganze Seite hinweg.
Gefahrlos erneut ausführen
Markierungen von markdown-toc (<!-- toc -->), Markdown All in One (<!-- TOC -->) und doctoc werden erkannt – ein aktualisiertes Verzeichnis wird nie doppelt eingefügt.
Saubere Linktexte
Fett, kursiv, Inline-Code und Links in Überschriften werden auf den sichtbaren Text reduziert, so wie die gerenderte Überschrift aussieht.
Alle Anker im Überblick
Der Reiter „Anker“ listet jede Überschrift mit Ebene und erzeugtem #anker auf – praktisch für Links von anderen Seiten. Auch mit === oder --- unterstrichene Überschriften werden gefunden.
Grenzen & Datenschutz
Dokumente bis 5 MB; größere Eingaben werden in einem Web Worker im Hintergrund verarbeitet, damit das Tippen flüssig bleibt. Das Inhaltsverzeichnis entsteht im Browser, die Datei wird nie hochgeladen. Mehr dazu auf der Datenschutzseite.
Häufige Fragen
Wie füge ich einem GitHub-README ein Inhaltsverzeichnis hinzu?
README einfügen, GitHub-Anker und die Ebenen H2 bis H3 beibehalten und das Dokument herunterladen. Das Verzeichnis steht unter dem Titel zwischen <!-- toc -->-Markierungen.
Was passiert mit Umlauten und ß in den Ankern?
Sie bleiben erhalten, genau wie auf GitHub: Aus „## Übersicht & Einführung“ wird der Anker #übersicht--einführung. Nur Satzzeichen wie & fallen weg.
Warum funktionieren meine Ankerlinks nicht?
Anker hängen von der Plattform ab. GitHub entfernt Satzzeichen und behält doppelte Bindestriche, GitLab fasst sie zusammen. Die Plattform wählen, auf der die Datei angezeigt wird.
Wie werden doppelte Überschriften behandelt?
Wie auf GitHub: Die zweite Überschrift „Installation“ erhält den Anker #installation-1, die dritte #installation-2. Ausgelassene Überschriften zählen trotzdem mit.
Lässt sich ein vorhandenes Inhaltsverzeichnis aktualisieren?
Ja. Steht bereits ein Verzeichnis zwischen bekannten Markierungen, wird nur dieser Block ersetzt; der Rest der Datei bleibt Byte für Byte gleich.
Geht auch ein nummeriertes Inhaltsverzeichnis?
Ja, als „Listenstil“ 1. item wählen. Jede Ebene wird für sich nummeriert und unter dem Text des übergeordneten Eintrags eingerückt.
Gehört der Dokumenttitel ins Inhaltsverzeichnis?
Meist nicht. „Titel (erste H1) auslassen“ lässt die erste H1 weg, sodass die Liste mit den Abschnitten beginnt.