Was ist ein Markdown Table of Contents Generator?
Ein Markdown-Inhaltsverzeichnisgenerator liest die Überschriften in einem Markdown-Dokument und erzeugt eine verschachtelte Liste von Links, die zu jedem Abschnitt springen Sie fügen Ihren Markdown ein, und das Tool gibt einen gebrauchsfertigen Block wie eine Aufzählungsliste zurück, in der jede Zeile ein ` [Heading] (#anchor) `-Link ist. Es erspart Ihnen, die Gliederung von Hand zu schreiben und die Anker-ID zu erraten, die ein Renderer jeder Überschrift zuweisen wird.
Das Herzstück des Tools ist der Anker slug. GitHub, GitLab und die meisten Generatoren statischer Standorte verwandeln eine Überschrift wie „Getting Started" in die id „`getting-started`", indem sie den Text untercasern, Interpunktion entfernen und Leerzeichen durch Bindestriche ersetzen. Dieser Generator wendet dieselbe Regel an, einschließlich des numerischen Suffixes (`, `-2`), das GitHub hinzufügt, wenn zwei Überschriften ein slug gemeinsam haben, sodass die Links, die es erzeugt, genau mit dem ids reADME- oder docs-Seite übereinstimmen. Es liest beide ATX-Überschriften (Zeilen, die mit dem unterstrichenen Code beginnen, der Text, der Block, der
Alles läuft in Ihrem Browser. Der Markdown, den Sie einfügen, wird mit clientseitigem JavaScript analysiert und verlässt Ihr Gerät nie, daher gibt es keinen Upload, kein Konto und keine Verfolgung Ihrer Inhalte. Das Tool funktioniert offline, sobald die Seite geladen wurde. Sie können die einzuschließenden Überschriftenebenen auswählen, zwischen Listen mit Aufzählungszeichen und nummerierten Listen wechseln und die Einrückung steuern. Sie aktualisiert die Gliederung, sobald Sie eine Option ändern.
Wie benutzt man den Markdown TOC Generator?
Füge deinen Markdown ein
Geben Sie Ihr vollständiges Markdown-Dokument oder README in das Eingabefeld ein Überschriften innerhalb eingezäunter Codeblöcke werden automatisch übersprungen.
Wählen Sie die Überschriftenebenen
Stellen Sie die flachsten und tiefsten Ebenen so ein, dass sie enthalten. Eine häufige Wahl ist H2 bis H3, wodurch die Gliederung lesbar bleibt, ohne jeden Unterabschnitt aufzulisten.
Wählen Sie den Listenstil aus
Wechseln Sie zwischen einer Liste mit Aufzählungszeichen oder Nummerierung, schalten Sie die Ankerverbindungen ein oder aus und wählen Sie die Einrückung mit zwei Leerzeichen, vier Leerzeichen oder Tabulatoren aus.
Kopieren Sie das Inhaltsverzeichnis
Kopieren Sie den generierten Markdown und fügen Sie ihn in der Nähe des oberen Randes Ihres Dokuments ein Jeder Eintrag verlinkt auf den passenden Überschriftenanker.
Hauptmerkmale
GitHub-kompatible Anker
Slugs stimmt mit den ids überein, die GitHub rendert, einschließlich numerischer Suffixe für doppelte Überschriften, sodass jeder Link korrekt aufgelöst wird.
Ebenenfilterung
Fügen Sie nur die gewünschten Überschriftsebenen hinzu. Die Einnistung wird anhand der flachsten enthaltenen Überschrift gemessen, sodass eine Liste, die bei H2 beginnt, bündig links bleibt.
Bestellt oder Unbestellt
Geben Sie eine Aufzählungsliste oder eine nummerierte Liste mit Zählern pro Ebene mit optionalen Ankerlinks und konfigurierbarer Einrückung aus.
Code-Block Aware
Überschriften, die in eingezäunten Codeblöcken geschrieben sind, werden ignoriert, sodass Beispielausschnitte niemals in Ihre Gliederung gelangen.
Frequently Asked Questions
Related Tools
HTML Table Generator
Generate an accessible HTML table from pasted CSV or tab-separated data. Add a header row, caption, striped rows, and borders, then copy the HTML and CSS. Runs client-side.
HTML to Markdown
Convert HTML to clean Markdown instantly. Turns headings, lists, links, images, blockquotes, code blocks and tables into portable GitHub Flavored Markdown. Tolerant of messy CMS markup. Runs client-side.
Markdown to HTML
Convert Markdown to clean, semantic HTML with GitHub Flavored Markdown support - tables, task lists, fenced code, heading anchors, live preview and a full HTML document export.
WordPress Readme Generator
Write a plugin readme.txt the WordPress.org directory parses, with a live preview of the listing it produces and a download when it is right.
Comments
0 comments
No comments yet. Be the first to share your thoughts!