Markdown-Inhaltsverzeichnis

Automatisch ein verlinktes Inhaltsverzeichnis zu Markdown-Dateien hinzufügen

Lange README-Dateien und interne Wikis stoßen immer wieder auf dasselbe Problem: Ein Leser scrollt durch die ganze Seite, bevor er den gesuchten Abschnitt findet. Wenn Sie schon einmal eine lange Markdown-Datei geöffnet und sich eine anklickbare Gliederung am Anfang gewünscht haben: Genau das erstellt Markdown-Inhaltsverzeichnis für Sie.

Sie geben eine einzelne Markdown-Datei an, das Tool liest jede Überschrift ein, wandelt sie in einen Link um und fügt diese Liste als neue Datei nahe dem Anfang ein, die Sie herunterladen können. Die Option „Überschriften bis Ebene einschließen“ lässt Sie zwischen 2, 3 oder 4 wählen; der Standardwert 3 erfasst normalerweise die Hauptabschnitte und ihre Unterabschnitte, ohne jede kleine Überschrift mit hineinzuziehen. Die Links folgen dem gängigen Markdown-Ankerstil, sodass sie in einem Code-Repository genauso funktionieren wie auf einer statischen Website.

Die Verarbeitung erfolgt auf den Servern der Website über eine sichere Verbindung, und die Datei wird innerhalb von sechzig Minuten gelöscht, sodass danach nichts zurückbleibt. Das Tool erstellt nur die Gliederung; es nummeriert Ihre Überschriften nicht neu und korrigiert keine Überschriften, die eine Ebene überspringen, sodass eine unregelmäßige Überschriftenstruktur ein unregelmäßiges Inhaltsverzeichnis ergibt. Bringen Sie die Überschriften zunächst in Ordnung, falls das Ergebnis falsch aussieht, und führen Sie das Tool dann erneut aus.

Die Nutzung ist im Rahmen eines Tageskontingents kostenlos, und ein kostenloses Konto hebt diese Grenze auf. Es funktioniert über den Browser an Computer oder Smartphone, ohne dass etwas installiert werden muss.