Markdown-Inhaltsverzeichnis-Generator
Erstellen Sie ein Inhaltsverzeichnis für Ihre README, dessen Links genau auf den Ankern landen, die GitHub tatsächlich erzeugt – auch bei chinesischen und doppelten Überschriften.
Eingabe
Ergebnis
Das Ergebnis erscheint hier.Ein Inhaltsverzeichnis nützt nur, wenn jeder Link irgendwo ankommt – und von Hand geschriebene Anker gehen auf vorhersehbare Weise kaputt: GitHub entfernt Satzzeichen, behält chinesische Zeichen, schreibt alles klein und nummeriert wiederholte Überschriften in der Reihenfolge des Dokuments mit -1, -2. Dieses Werkzeug liest Ihr Markdown, findet jede Überschrift außerhalb von Code-Fences und Front Matter und schreibt eine verschachtelte Liste, deren Anker denselben Regeln folgen wie github-slugger, die Bibliothek, die das Verhalten von github.com nachbildet. Die Liste lässt sich auch zwischen die Marker <!-- toc --> und <!-- tocstop --> setzen – die Konvention des Kommandozeilenwerkzeugs markdown-toc –, sodass ein erneuter Durchlauf die alte Liste ersetzt, statt eine zweite hinzuzufügen.
So arbeitet es
- Erkannt werden sowohl #-Überschriften als auch unterstrichene Überschriften (=== und ---); Zeilen innerhalb von ```- oder ~~~-Fences, YAML-Front-Matter und HTML-Kommentare werden übersprungen.
- Die Anker entstehen aus dem Text, den GitHub rendert: Links, Hervorhebungen und Inline-Code werden auf ihren Text reduziert, Satzzeichen entfallen, Leerzeichen werden zu Bindestrichen.
- Jede Überschrift zählt für die Nummerierung -1, -2 der Duplikate mit, auch solche unterhalb der gewählten Tiefe, denn GitHub nummeriert sie alle.
- Legen Sie die maximale Tiefe und das Aufzählungszeichen fest, ob der Dokumenttitel (eine führende H1) ausgelassen wird und ob das gesamte Dokument mit der zwischen den Markern eingefügten Liste zurückgegeben werden soll.
Wohin Ihre Daten gehen
Nirgendwohin. Dieses Werkzeug läuft vollständig in Ihrem Browser: Der eingefügte Text wird von der Seite verarbeitet und weder an einen Server übertragen noch protokolliert.
Dieses Tool ist kostenlos und braucht kein Konto. Die Ergebnisse existieren nur in Ihrer geöffneten Seite und werden nirgends gespeichert.
Was es kostet
Dieses Werkzeug ist kostenlos, ohne Anmeldung und ohne Punkte.
Häufige Fragen
- Warum behält der Anker einer chinesischen Überschrift die Zeichen?
- Weil GitHub sie behält. Seine Slug-Regel entfernt nur Satzzeichen und Symbole, daher verlinkt ## 安装与使用 auf #安装与使用 und ## FAQ：为什么选择 Rust？ auf #faq为什么选择-rust – der vollbreite Doppelpunkt und das Fragezeichen fallen weg, die Zeichen bleiben. Browser kodieren den Link beim Aufrufen mit Prozentzeichen; das ist so vorgesehen.
- Funktionieren die Links auch auf GitLab oder Gitea?
- Größtenteils. GitLab und Gitea bilden Slugs aus Überschriften sehr ähnlich, und einfache englische Überschriften ergeben überall denselben Anker. Unterschiede gibt es in Randfällen – wiederholte Überschriften, einige Satzzeichen, nicht lateinische Schrift in älteren Versionen. Klicken Sie die Links auf einer anderen Plattform als GitHub daher nach dem Veröffentlichen einmal durch.
- Wie aktualisiere ich das Inhaltsverzeichnis, nachdem ich Abschnitte hinzugefügt habe?
- Setzen Sie <!-- toc --> in eine eigene Zeile an die Stelle, an die die Liste gehört, und <!-- tocstop --> dahinter, aktivieren Sie das Einfügen zwischen den Markern und lassen Sie das ganze Dokument verarbeiten. Alles zwischen den Markern wird ersetzt, und Überschriften in der alten Liste werden ignoriert. Ein erneuter Durchlauf liefert also dasselbe Ergebnis statt einer Liste, die jedes Mal länger wird.
- Werden auch in HTML geschriebene Überschriften wie <h2> erkannt?
- Nein. Aufgeführt werden nur Markdown-Überschriften – #-Zeilen und mit === oder --- unterstrichene Zeilen. Ein <h2>-Tag im Markdown taucht in der Liste nicht auf; schreiben Sie es als ## um, wenn es enthalten sein soll.
Das Open Source dahinter
Dieses Werkzeug ist eine eigenständige Implementierung ohne fremde Bibliothek. jonschlinkert/markdown-toc (MIT) erledigt dieselbe Aufgabe als Bibliothek — wer sie im eigenen Programm braucht, fängt dort an, statt eine Webseite aufzurufen.
jonschlinkert/markdown-tocAuch bekannt als
- Markdown Inhaltsverzeichnis erstellen
- markdown toc generator
- README Inhaltsverzeichnis
- GitHub Markdown Anker Links
- Markdown TOC generieren
- Inhaltsverzeichnis Markdown automatisch