Ein Inhaltsverzeichnis fuer jede Markdown-Datei in fuenf Sekunden
Lange Doku-Dateien (eine 800-Zeilen-README, ein Changelog, eine Deploy-Anleitung) sind schwer ohne Inhaltsverzeichnis oben zu lesen. Leser wollen mit einem Klick zu "Troubleshooting" oder "API-Referenz" springen, nicht zehn Bildschirme scrollen.
Das Tool liest dein Markdown, sammelt jede Ueberschrift (H1 bis H6) und baut eine verschachtelte Bullet-Liste mit Links zu Ankern. Die Links funktionieren direkt auf GitHub, GitLab, Docusaurus, Astro und den meisten Static-Site-Generators.
Wir ueberspringen Ueberschriften in Fenced-Code-Bloecken (`# ist keine H1, wenn es in \`\`\`bash sitzt`). Der Generator unterstuetzt drei Anker-Styles (GitHub, GitLab, Plain), einen "In Dokument einfuegen"-Modus, optionale `<!-- TOC -->`-Marker fuer Auto-Update-Tools und einen "Erste H1 ueberspringen"-Toggle.
So nutzt du das Tool
- Markdown pasten ins linke Panel. Ein kurzes Sample ist per Default geladen.
- Tiefenbereich mit den Slidern setzen, Default H1 bis H4. Willst du keine kleinen Ueberschriften, setz Max auf H3. Nur Top-Level-Abschnitte, Max auf H2.
- Anker-Style waehlen: GitHub (haeufigster, funktioniert auch auf GitLab und Docusaurus), GitLab (sehr aehnlich, kleine Unterschiede bei fuehrenden Ziffern), Plain (klassisches Slugify, nur ASCII).
- "Nummerierte Liste" aktivieren, wenn du `1.` statt `-` bevorzugst. Die Nummern passen sich beim Rendern automatisch an (GitHub zeigt 1, 2, 3, auch wenn jeder Eintrag `1.` ist).
- "Erste H1 ueberspringen": ist die erste Zeile der Datei der Doku-Titel (z.B. Projektname in einer README), willst du sie meistens nicht im TOC.
- "Einfuege-Modus": statt nur des TOC gibt der Generator das volle Dokument mit eingefuegtem TOC direkt nach der ersten H1 zurueck. Praktisch bei bestehender grosser Datei.
- TOC kopieren (oder das volle Dokument im Einfuege-Modus) und in deine Datei pasten. Oder als .md-Datei runterladen.
Wann das nuetzlich ist
Konkrete Situationen, in denen ein Inhaltsverzeichnis sich auszahlt:
- Grosse Open-Source-README. Datei hat 12 Sections, "Installation", "Quick Start", "Configuration", "API", "Examples", "Troubleshooting", "Contributing", "License". Ohne TOC scrollt der User. Mit TOC klickt er und landet.
- Ein CHANGELOG.md mit Dutzenden Versionen. TOC zu jeder Version (`## v1.4.2, 2025-10-12`, `## v1.4.1, 2025-10-08`...) laesst Leser zum interessanten Release in einem Klick springen.
- Technische Docs auf Docusaurus/Astro/MkDocs. Manche Themes rendern automatisch ein TOC in der Sidebar, aber ein in-Page-TOC hilft trotzdem bei langen Artikeln.
- Docs aus Confluence/Notion migrieren. Exports kommen selten mit nutzbarem TOC. Pasten, generieren, Ergebnis oben pasten.
- Buch oder Langform-Artikel in Markdown. Technische Buecher werden oft in Markdown geschrieben (Pragmatic Bookshelf, Manning). Jedes Kapitel braucht einen Section-Index.
- Interne Firmen-Docs. Die Infra-Repo-README, ein Incident-Runbook, ein Onboarding-Doc, alles mit mehr als 5 Sections.
Baust du eine README von Grund auf, nimm unseren README-Builder, der fuegt das TOC automatisch hinzu. Nach dem Aufraeumen schick die Datei durch unseren Markdown-Linter, der faengt typische Anker-Link-Fehler.