Wichtige Fakten
- Kategorie
- Konvertierung & Kodierung
- Eingabetypen
- textarea, select, checkbox
- Ausgabetyp
- text
- Sample-Abdeckung
- 4
- API verfügbar
- Yes
Überblick
Der Markdown-Inhaltsverzeichnis-Generator erstellt automatisch strukturierte Inhaltsverzeichnisse (TOC) aus Ihren Markdown-Dokumenten. Durch das Auslesen von Überschriften generiert das Tool übersichtliche Listen mit optionalen GitHub-kompatiblen Anker-Links, um die Navigation in langen Dokumenten wie READMEs oder Dokumentationen zu erleichtern.
Wann verwenden
- •Beim Erstellen oder Aktualisieren von README-Dateien für GitHub-Repositories, um eine schnelle Navigation zu ermöglichen.
- •Bei der Strukturierung langer technischer Dokumentationen oder Blogbeiträge, die im Markdown-Format verfasst sind.
- •Wenn Sie manuell erstellte, fehleranfällige Sprunglinks durch automatisch generierte GitHub-Stil-Anker ersetzen möchten.
So funktioniert es
- •Fügen Sie Ihren Markdown-Text in das Eingabefeld für die Markdown-Eingabe ein.
- •Wählen Sie die gewünschte minimale und maximale Überschriftenebene (z. B. H1 bis H3) sowie den Listen- und Einzugsstil aus.
- •Aktivieren oder deaktivieren Sie die Optionen für Anker-Links und das gewünschte Ausgabeformat (Markdown, HTML oder beides).
- •Kopieren Sie das generierte Inhaltsverzeichnis direkt aus dem Ausgabebereich in Ihr Dokument.
Anwendungsfälle
Beispiele
1. Inhaltsverzeichnis für ein GitHub-README erstellen
Open-Source-Entwickler- Hintergrund
- Ein Entwickler pflegt ein großes Open-Source-Projekt, dessen README.md-Datei sehr lang geworden ist. Nutzer beschweren sich über mangelnde Übersicht.
- Problem
- Das manuelle Erstellen und Verlinken von Überschriften ist zeitaufwendig und fehleranfällig.
- Verwendung
- Er fügt den Inhalt der README.md in das Tool ein, wählt die Überschriftenebenen H2 bis H4, aktiviert die Anker-Links und wählt den ungeordneten Listenstil mit 2 Leerzeichen Einzug.
- Beispielkonfiguration
-
markdownInput: [Markdown-Text], minLevel: '2', maxLevel: '4', listStyle: 'unordered', indent: '2spaces', includeAnchor: true, outputFormat: 'markdown' - Ergebnis
- Ein sauberes, eingerücktes Markdown-Inhaltsverzeichnis mit funktionierenden GitHub-Anker-Links, das direkt am Anfang der README.md eingefügt werden kann.
2. HTML-Inhaltsverzeichnis für einen Blogbeitrag generieren
Technischer Redakteur- Hintergrund
- Ein Redakteur schreibt Blogbeiträge in Markdown, das CMS benötigt jedoch ein HTML-basiertes Inhaltsverzeichnis für die Sidebar.
- Problem
- Die manuelle Konvertierung von Markdown-Überschriften in HTML-Listen mit Ankern dauert zu lange.
- Verwendung
- Er fügt den Markdown-Entwurf ein, wählt als Ausgabeformat 'HTML' und stellt die Ebenen auf H1 bis H3 ein.
- Beispielkonfiguration
-
markdownInput: [Markdown-Text], minLevel: '1', maxLevel: '3', outputFormat: 'html', wrapCodeBlock: false - Ergebnis
- Eine fertige HTML-Liste mit Anker-Links, die direkt in das CMS-Template kopiert werden kann.
Mit Samples testen
markdown, barcodeVerwandte Hubs
FAQ
Welche Überschriftenebenen werden unterstützt?
Das Tool unterstützt alle Standard-Markdown-Überschriften von H1 bis H6. Sie können die minimale und maximale Ebene flexibel filtern.
Sind die generierten Anker-Links mit GitHub kompatibel?
Ja, die Anker-Links werden standardmäßig im GitHub-Stil generiert, sodass sie direkt in Repositories funktionieren.
Kann ich das Inhaltsverzeichnis auch als HTML ausgeben?
Ja, Sie können das Ausgabeformat auf Markdown, HTML oder eine Kombination aus beiden einstellen.
Was bewirkt die Option 'In Code-Block einwickeln'?
Diese Option umschließt das generierte Inhaltsverzeichnis mit Code-Tags, um das Kopieren des rohen Markdown-Codes zu erleichtern.
Unterstützt das Tool nummerierte Listen?
Ja, Sie können im Listenstil zwischen ungeordneten Listen (mit Spiegelstrichen) und geordneten Listen (nummeriert) wählen.