Startseite › Entwickler-Tools › Markdown-Inhaltsverzeichnis-Generator

Markdown-Inhaltsverzeichnis-Generator

Füge deine README oder eine beliebige Markdown-Datei ein und erhalte ein verschachteltes, verlinktes Inhaltsverzeichnis aus ihren Überschriften. Die Anker folgen den Regeln von GitHub oder GitLab (inklusive Duplikaten), sodass jeder Link zum richtigen Abschnitt springt, und du kannst das Inhaltsverzeichnis direkt ins Dokument einfügen.

Zuletzt aktualisiert:

Anzeige
Anzeige

Anleitung: Markdown-Inhaltsverzeichnis-Generator

  1. Füge dein Markdown ein oder öffne eine .md-Datei. Eine Beispiel-README ist geladen, damit du das Ergebnis sofort siehst.
  2. Wähle die Überschriftenebenen, die enthalten sein sollen. Viele READMEs lassen den H1-Titel weg und listen H2- und H3-Abschnitte.
  3. Wähle die Ankerregeln für den Ort, an dem die Datei angezeigt wird (GitHub oder GitLab), sowie Aufzählungs- und Einzugsstil.
  4. Kopiere das Inhaltsverzeichnis und füge es unter deinem Titel ein, oder nutze In Dokument einfügen, um es zwischen <!-- toc -->-Markern hinzuzufügen.
  5. Jederzeit neu erzeugen: Füge die aktualisierte Datei ein und füge erneut ein; das alte Inhaltsverzeichnis zwischen den Markern wird ersetzt.

So werden Überschriften-Anker erzeugt

Sowohl GitHub als auch GitLab machen aus dem sichtbaren Text einer Überschrift eine id, auf die du mit #anker verlinken kannst. Die Schritte sind:

  1. Nur der gerenderte Text zählt: **fett**, [Links](url) und Inline-HTML werden auf ihren Text reduziert, Bilder verschwinden, und `code` behält seinen Inhalt.
  2. In Kleinbuchstaben umwandeln.
  3. Satz- und Sonderzeichen entfernen. Buchstaben (auch mit Akzenten und nicht-lateinische), Ziffern, Leerzeichen, Bindestriche und Unterstriche bleiben.
  4. Jedes Leerzeichen durch einen Bindestrich ersetzen. GitLab fasst außerdem mehrere Bindestriche zu einem zusammen.
  5. Wenn der Anker weiter oben im Dokument bereits existiert, der Reihe nach -1, -2, … anhängen.
ÜberschriftGitHub-AnkerGitLab-Anker
## Getting Started#getting-started#getting-started
## What's New in v2.0?#whats-new-in-v20#whats-new-in-v20
## Options & Flags#options--flags#options-flags
## Config file (`.acmerc`)#config-file-acmerc#config-file-acmerc
## snake_case_names#snake_case_names#snake_case_names
## Usage (zum zweiten Mal)#usage-1#usage-1
## Café Menü#café-menü#café-menü

Tipps für ein gutes README-Inhaltsverzeichnis

  • Lass die H1 weg. Der Titel steht schon oben auf der Seite, daher beginnen die meisten Inhaltsverzeichnisse bei H2. Tiefer als H3 macht die Liste meist zu lang zum Überfliegen.
  • Überspring keine Ebenen. Ein Sprung von H2 direkt zu H4 bricht die Gliederung; der Generator ordnet den Eintrag trotzdem unter dem nächsten übergeordneten ein und warnt dich.
  • Nummerierte Inhaltsverzeichnisse brauchen mehr Einzug. In CommonMark muss ein verschachtelter Eintrag mit dem Text nach 1. fluchten, daher werden nummerierte Listen mindestens 3 Leerzeichen eingerückt, auch wenn 2 gewählt sind.
  • Nutze die Marker. <!-- toc --> und <!-- tocstop --> sind dieselben Marker wie beim beliebten markdown-toc-CLI, sodass der erzeugte Block auch von diesem Tool in einem Pre-Commit-Hook aktualisiert werden kann.
  • Eine umbenannte Überschrift ändert ihren Anker und bricht Links von anderen Seiten. Erzeuge das Inhaltsverzeichnis nach Änderungen neu und prüfe externe Links.

Schreibst du die README selbst? Beginne mit dem README-Generator und formatiere Daten mit dem Markdown-Tabellen-Generator.

Häufige Fragen

Wie erstellt GitHub Anker für Überschriften?

GitHub nimmt den Text der Überschrift, wandelt ihn in Kleinbuchstaben um, entfernt Satz- und Sonderzeichen (Buchstaben, Ziffern, Leerzeichen, Bindestriche und Unterstriche bleiben) und ersetzt jedes Leerzeichen durch einen Bindestrich. So wird ## What's New? zu #whats-new. Formatierungen wie Fettdruck oder Links werden vorher entfernt, und nur der sichtbare Text wird verwendet.

Was passiert bei doppelten Überschriften?

Die erste Überschrift behält den einfachen Anker, spätere erhalten -1, -2 und so weiter. Zwei Abschnitte namens Usage werden zu #usage und #usage-1. Der Generator nummeriert Duplikate in der Reihenfolge im Dokument, genau wie GitHub und GitLab.

Unterscheiden sich GitLab-Anker von denen bei GitHub?

Größtenteils sind sie gleich, mit einem praktischen Unterschied: GitLab fasst mehrere Bindestriche zu einem zusammen, sodass A - B auf GitLab zu #a-b wird, auf GitHub aber zu #a---b. Wähle die GitLab-Option, wenn deine README dort gehostet ist.

Warum fehlen manche Überschriften in meinem Inhaltsverzeichnis?

Zeilen, die in Codeblöcken (``` oder ~~~) mit # beginnen, sind Code und keine Überschriften, daher werden sie übersprungen. Überschriften außerhalb des gewählten Tiefenbereichs werden weggelassen, und in CommonMark muss auf ein # ein Leerzeichen folgen, damit es als Überschrift zählt.

Wie halte ich das Inhaltsverzeichnis aktuell?

Füge das Inhaltsverzeichnis mit den Markern <!-- toc --> und <!-- tocstop --> ein. Beim nächsten Mal fügst du die bearbeitete Datei ein und klickst erneut auf In Dokument einfügen: Alles zwischen den Markern wird durch ein frisches Inhaltsverzeichnis ersetzt. Die Marker sind HTML-Kommentare und daher auf GitHub unsichtbar.

Erstellt GitHub automatisch ein Inhaltsverzeichnis?

GitHub zeigt im Dateibetrachter ein Gliederungsmenü für README- und Markdown-Dateien, fügt der gerenderten Seite selbst aber kein Inhaltsverzeichnis hinzu. Ein Inhaltsverzeichnis in der Datei ist auf der Seite, auf npm, in Editoren und in exportierten Dokumenten sichtbar.

Werden alle Tools auf FreeToolCabin auf Qualität und Genauigkeit getestet?

Ja. Jedes Tool auf der Website durchläuft automatische Tests in echten Browsern, die prüfen, ob das Ergebnis stimmt und keine Fehler auftreten. Wenn du einen Fehler findest oder einen Vorschlag hast, schreib uns an [email protected] – wir sehen es uns an.

Ähnliche Tools

Alle Code-Generatoren & Builder ansehen →