Markdown Inhaltsverzeichnis Generator

Ein kostenloses Tool, das automatisch ein Inhaltsverzeichnis (TOC) für Dokumente im Markdown-Format generiert. Es erspart Ihnen die Mühe, ein Inhaltsverzeichnis manuell zu erstellen, wenn Sie technische Artikel für Plattformen wie GitHub-READMEs oder Blogs schreiben.

Sie können den Extraktionsbereich der Überschriftenebenen (h1-h6) sowie das Ausgabeformat wie ungeordnete Listen (-) oder geordnete Listen (1.) detailliert anpassen.

Die gesamte Verarbeitung findet innerhalb Ihres Browsers statt, sodass die von Ihnen eingegebenen Textdaten niemals an einen externen Server gesendet werden. Sie können es problemlos für vertrauliche Dokumente oder private Notizen verwenden, ohne sich Sorgen um Datenlecks machen zu müssen.

Markdown

Eine leichtgewichtige Auszeichnungssprache zur Formatierung von Text. Sie verwendet Symbole, um einfach Überschriften, Listen, Links usw. auszudrücken, und ist besonders bei Programmierern weit verbreitet.

TOC (Table of Contents)

Zu Beginn eines langen Dokuments platziert, ermöglicht es den Lesern, schnell auf den gewünschten Abschnitt zuzugreifen, was die Lesbarkeit verbessert.

Überschriftenebene

Ein Indikator für die hierarchische Struktur eines Dokuments, der den HTML-Tags h1 bis h6 entspricht. In Markdown wird die Ebene durch die Anzahl der "#" ausgedrückt.

Anker-Link

Ein Link zum Springen an eine bestimmte Stelle innerhalb einer Seite. In einem Markdown-Inhaltsverzeichnis wird durch die Angabe einer automatisch generierten ID (z.B. `#heading`) basierend auf dem Überschriftentext gesprungen.

Clientseitige Verarbeitung

Ein Mechanismus, bei dem ein Programm nur innerhalb des Browsers des Benutzers ausgeführt wird, ohne mit einem Server zu kommunizieren. Es besteht kein Risiko von Datenlecks und bietet hervorragende Sicherheit.

Q.Wird die eingegebene Markdown-Datei auf dem Server gespeichert?

Nein, wird sie nicht. Da dieses Tool clientseitig arbeitet und vollständig im Browser ausgeführt wird, wird der eingegebene Text niemals an einen externen Server gesendet. Sie können es bedenkenlos für Dokumente mit vertraulichen Informationen nutzen.

Q.Ein Klick auf den generierten Inhaltsverzeichnis-Link springt nicht.

Abhängig von der Plattform (GitHub, etc.) können die Regeln zur automatischen Generierung von Anker-IDs aus Überschriften variieren. Dieses Tool generiert IDs basierend auf gängigen Regeln (Kleinbuchstaben, Ersetzen von Leerzeichen durch Bindestriche, etc.), aber möglicherweise müssen Sie diese manuell anpassen, um den spezifischen Vorgaben der Plattform zu entsprechen.

Q.Kann ich eine bestimmte Überschrift vom Inhaltsverzeichnis ausschließen?

In der aktuellen Version werden alle Überschriften unter der angegebenen "Max. Ebene" extrahiert. Es gibt keine Funktion, um nur bestimmte Überschriften auszuschließen. Bitte löschen Sie diese nach der Generierung manuell.

Q.Werden auch '#' innerhalb von Codeblöcken extrahiert?

Nein, der Extraktionsalgorithmus unseres Tools ist so konzipiert, dass Text in Codeblöcken, die von drei Backticks (```) umgeben sind, ignoriert wird. Daher werden Kommentare im Code nicht fälschlicherweise als Inhaltsverzeichnis extrahiert.

Q.Werden nicht-englische Überschriften unterstützt?

Ja. Überschriften in Japanisch, Englisch und anderen Sprachen werden korrekt extrahiert und als Inhaltsverzeichnis generiert. Da die Regel für die Generierung der Anker-Link-ID jedoch auf Englisch basiert, können nicht-englische Überschriften in einigen Fällen URL-kodiert sein.