Tokenlabor

Markdown-Inhaltsverzeichnis erstellen

Markdown-Inhaltsverzeichnis aus den Überschriften Ihres Textes erzeugen, mit verschachtelter Liste und Links auf GitHub-kompatible Anker, auf Wunsch direkt ins Dokument eingefügt.

Markdown
Inhaltsverzeichnis

Alles läuft in Ihrem Browser. Eingaben verlassen Ihr Gerät nicht.

Table of Contents für README und Doku

Ein Markdown-Inhaltsverzeichnis macht lange README-Dateien und Dokumentationen übersichtlich. Dieser TOC-Generator liest alle Überschriften aus Ihrem Text, sowohl im #-Stil als auch unterstrichen mit === und ---, und erzeugt daraus eine verschachtelte Liste mit Links. Codeblöcke werden übersprungen, damit Kommentare mit # in Shell- oder Python-Beispielen nicht als Überschrift zählen.

Die Links folgen den GitHub-Anker-Regeln: Text in Kleinbuchstaben, Satzzeichen entfernt, Leerzeichen durch Bindestriche ersetzt, Umlaute bleiben erhalten. Aus „Über uns & Kontakt“ wird #über-uns--kontakt. Kommt eine Überschrift mehrfach vor, hängt GitHub -1, -2 an; auch das bildet der Generator nach. So können Sie Überschriften verlinken, ohne Anker von Hand zu raten. GitLab, VS Code und viele Static-Site-Generatoren erzeugen weitgehend gleiche Anker, im Detail kann es Abweichungen geben.

Mit „Ganzes Dokument“ setzt das Werkzeug das Verzeichnis an die Stelle eines Markers <!-- toc --> oder, falls es keinen gibt, nach der ersten Hauptüberschrift. Ein Table of Contents muss nach Änderungen an Überschriften neu erzeugt werden; wenn Sie das automatisieren möchten, gibt es dafür Editor-Erweiterungen und GitHub zeigt zusätzlich ein eigenes Verzeichnis über das Listensymbol an. Das Ergebnis prüfen Sie in der Markdown-Vorschau.

Anleitung: Markdown-Inhaltsverzeichnis in 4 Schritten

  1. Den Markdown-Text in das Feld „Markdown“ einfügen oder mit „Beispiel“ ein Muster laden.
  2. Mit „Ab Ebene“ und „Bis Ebene“ festlegen, welche Überschriften ins Inhaltsverzeichnis kommen.
  3. Listenform, Einrückung je Ebene und optional eine Überschrift über dem Verzeichnis wählen.
  4. Unter Ausgabe „Nur Inhaltsverzeichnis“ oder „Ganzes Dokument mit Verzeichnis“ wählen und das Ergebnis kopieren.

Typische Anwendungsfälle

  • Lange README-Dateien auf GitHub mit einem verlinkten Table of Contents übersichtlich machen.
  • Projektdokumentation in GitLab oder einem Wiki mit Sprungmarken zu jedem Abschnitt versehen.
  • Ein Inhaltsverzeichnis nach dem Umbenennen von Überschriften schnell neu erzeugen.
Fragen

Häufige Fragen

Wie verlinke ich in Markdown auf eine Überschrift?

Mit einem Link auf den Anker, zum Beispiel [Installation](#installation). Der Anker entsteht aus dem Überschriftentext in Kleinbuchstaben, ohne Satzzeichen, mit Bindestrichen statt Leerzeichen.

Was passiert mit Umlauten im Anker?

GitHub behält Umlaute bei: Aus „Größe ändern“ wird #größe-ändern. Browser kodieren das beim Aufruf automatisch, der Link funktioniert.

Warum fehlt meine Überschrift im Verzeichnis?

Prüfen Sie die Ebenen-Einstellung: Standardmäßig werden H2 und H3 aufgenommen. Überschriften in Codeblöcken werden absichtlich ignoriert, und nach dem # muss ein Leerzeichen stehen.

Wo wird das Verzeichnis eingefügt?

Bei „Ganzes Dokument“ an der Stelle von <!-- toc -->. Gibt es den Marker nicht, direkt nach der ersten H1-Überschrift, sonst am Anfang.

Wie füge ich ein Inhaltsverzeichnis in eine GitHub-README ein?

Setzen Sie an die gewünschte Stelle den Marker <!-- toc -->, fügen Sie das ganze Dokument hier ein und wählen Sie „Ganzes Dokument mit Verzeichnis“. Die Ausgabe enthält das Verzeichnis an der Stelle des Markers und kann direkt in die README übernommen werden.

Unterstützt Markdown ein automatisches Inhaltsverzeichnis?

Standard-Markdown kennt keinen Befehl dafür. Manche Werkzeuge wie Static-Site-Generatoren oder Editor-Erweiterungen bieten eigene Platzhalter wie [TOC]; auf GitHub erzeugen Sie das Verzeichnis als normale Linkliste, wie es dieser Generator tut.

Weitere Werkzeuge

Das könnte auch helfen

Alle 358 Werkzeuge

Cron-Ausdruck erklären

Crontab-Zeilen mit 5 oder 6 Feldern auf Deutsch erklärt, mit den nächsten 10 Ausführungen.

Öffnen

Cron-Generator

Zeitplan im Formular wählen und die fertige Crontab-Zeile kopieren.

Öffnen

Unix-Zeitstempel umrechnen

Timestamp in Datum und zurück, Sekunden und Millisekunden erkannt, UTC und Berlin.

Öffnen

UUID-Generator

UUID v4 und v7 erzeugen, bis zu 1.000 auf einmal, und vorhandene UUIDs prüfen.

Öffnen

ULID-Generator

Sortierbare IDs in Crockford Base32 erzeugen, dekodieren und in UUID umwandeln.

Öffnen

Texte vergleichen (Diff)

Unterschiede zwischen zwei Texten zeilen-, wort- oder zeichenweise finden.

Öffnen