Markdown-Inhaltsverzeichnis-Generator

Erhalten Sie ein klickbares, verschachteltes Inhaltsverzeichnis für jedes Markdown-Dokument.

Läuft in Ihrem Browser
Keine Uploads
Kein Konto

Ihr Browser-Tool wird geladen…

Was Markdown-Inhaltsverzeichnis-Generator macht

Eine lange README, SOP oder Admin-Anleitung braucht oben ein Inhaltsverzeichnis, und es von Hand synchron zu halten, geht leicht schief. Fügen Sie das ganze Dokument ein, und der Generator liest jede Überschrift, auch mit === und --- unterstrichene, und schreibt eine verschachtelte Liste von Links, die zu jedem Abschnitt springen.

Wählen Sie mit „Einbeziehen bis“, wie tief es gehen soll, von nur H2 bis zu allen Ebenen. Ein einzelner H1-Titel wird standardmäßig weggelassen, da er meist das Dokument selbst benennt. Aktivieren Sie „Nummeriertes Verzeichnis“ für eine Gliederung mit 1., 2., 3., die auch als schnelle Übersicht der Überschriften dient, wenn Sie ein Dokument umbauen.

Beispiel

Eingabe

# Recorder-Handbuch

## Vor der Aufnahme
### Mikrofontest (2 min)
## Bearbeitung
### Pausen kürzen
## Bearbeitung
#### Tastenkürzel

Ergebnis

- [Vor der Aufnahme](#vor-der-aufnahme)
  - [Mikrofontest (2 min)](#mikrofontest-2-min)
- [Bearbeitung](#bearbeitung)
  - [Pausen kürzen](#pausen-kürzen)
- [Bearbeitung](#bearbeitung-1)

Der H1-Titel wird übersprungen, die H4 liegt unter der Standardtiefe H3, die Klammern verschwinden aus dem Anker, und die zweite Überschrift Bearbeitung verlinkt auf #bearbeitung-1.

Anleitung: Markdown-Inhaltsverzeichnis-Generator

Fügen Sie das vollständige Markdown-Dokument ein, oder klicken Sie auf „Datei öffnen“, um eine .md-Datei zu laden.
Wählen Sie eine Ebene unter „Einbeziehen bis“; unter „Weitere Optionen“ finden Sie „Einzelnen H1-Titel weglassen“ und „Nummeriertes Verzeichnis“.
Klicken Sie auf „Kopieren“ oder auf „.md herunterladen“ und fügen Sie die Liste unter dem Titel Ihres Dokuments ein.

Gut zu wissen

GitLab, Bitbucket, Docusaurus und andere Renderer bilden ids für Überschriften mit Satzzeichen oder nicht lateinischen Buchstaben eventuell anders als GitHub; testen Sie dort also ein paar Links.
Überschriften in abgegrenztem Code werden ignoriert, wie es sein soll, aber auch Überschriften, die als rohes HTML wie <h2> geschrieben sind, werden nicht erfasst.
Die Liste ist eine Momentaufnahme. Wenn Sie Überschriften umbenennen oder hinzufügen, erstellen Sie sie neu; nichts hält sie aktuell.

Fragen zu Markdown-Inhaltsverzeichnis-Generator

Wie füge ich einer GitHub-README ein Inhaltsverzeichnis hinzu?

Fügen Sie die README hier ein, kopieren Sie die erzeugte Liste und setzen Sie sie unter den Titel. Jeder Eintrag verlinkt auf einen Anker, den GitHub für diese Überschrift erzeugt. GitHub hat für README-Dateien auch ein Gliederungsmenü, eine Liste in der Datei funktioniert aber in jedem Viewer.

Warum springt ein Link im Inhaltsverzeichnis nicht zu seiner Überschrift?

Meist hat sich die Überschrift geändert, nachdem die Liste erstellt wurde, oder Ihre Website bildet Anker anders als GitHub. Erstellen Sie die Liste aus dem aktuellen Text neu und vergleichen Sie einen Anker mit der id, die Ihre Website tatsächlich an diese Überschrift setzt.

Sollte ein Inhaltsverzeichnis H4-Überschriften enthalten?

Meist nicht. Leser überfliegen H2-Abschnitte, und H3 liefert für lange Anleitungen genug Details. Tiefere Ebenen machen die Liste länger als der Inhalt, den sie zusammenfasst; bleiben Sie also beim Standard H3 und wählen Sie H4 oder „Alle“ nur für Referenzdokumentation.

Kann ich das Inhaltsverzeichnis nummerieren?

Ja. Aktivieren Sie „Nummeriertes Verzeichnis“ unter „Weitere Optionen“. Jede Ebene wird ab 1 nummeriert und um drei Leerzeichen eingerückt, sodass sie als verschachtelte nummerierte Liste dargestellt wird.