Markdown-Inhaltsverzeichnis für eine GitHub-README erstellen
Erstelle ein klickbares Inhaltsverzeichnis für eine GitHub-README. Kopiere eine Vorlage mit Unterpunkt, prüfe doppelte Anker und repariere Links.
Auf dieser Seite
01Eine vollständige README mit Inhaltsverzeichnis kopieren02Den tatsächlichen Überschriftenanker findenSetze eine Aufzählung an den Anfang deiner README. Ein Eintrag wie [Quick start](#quick-start) führt zur Überschrift ## Quick start. Der Text in eckigen Klammern ist die sichtbare Beschriftung. Hinter der Raute steht der Anker der Überschrift.
GitHub erstellt aus den Überschriften einer gerenderten Markdown-Datei auch eine Gliederung. Damit kannst du eine fremde README durchsuchen. Ein sichtbares Inhaltsverzeichnis im Dokument führt Leser direkt zu den Abschnitten, die sie am häufigsten benötigen. GitHub-Dokumentation zu README-Dateien
Die Vorlage enthält einen eingerückten Eintrag und zwei gleichnamige Überschriften. Kopiere den Code in eine Markdown-Datei und probiere alle vier Links aus.
# Field Notes
## Contents
- [Quick start](#quick-start)
- [Import a notebook](#import-a-notebook)
- [Examples for writers](#examples)
- [Examples for reviewers](#examples-1)
## Quick start
Open a notebook and add your first entry.
### Import a notebook
Choose an existing folder of Markdown notes.
## Examples
Writers can group entries by trip.
## Examples
Reviewers can scan entries by date.
Import a notebook steht eingerückt unter Quick start. Im Haupttext gilt dieselbe Hierarchie mit H3 und H2. Beide Abschnitte heißen Examples. Im Verzeichnis beschreiben die Linktexte, für wen der jeweilige Abschnitt gedacht ist. Die beiden Fragmente wählen unterschiedliche Ziele.
Bei einer einfachen Überschrift wandelt GitHub Buchstaben in Kleinbuchstaben und Leerzeichen in Bindestriche um. Satzzeichen wie Fragezeichen und Formatierungsmarken fallen weg. Ergibt eine weitere Überschrift denselben Anker, hängt GitHub eine Nummer an. In der Vorlage heißen die Ziele #examples und #examples-1. GitHubs Regeln für Abschnittslinks
Bei Sonderzeichen, Satzzeichen oder formatierter Schrift lässt sich das Ergebnis direkt prüfen. Öffne die gerenderte Datei, fahre mit der Maus über die Überschrift und klicke auf das Linksymbol. Kopiere das Fragment aus der Browseradresse. Verlinkst du aus einer anderen Markdown-Datei im selben Ordner, setze den Dateinamen davor, etwa [Quick start](README.md#quick-start).
| Was passiert | Was du prüfen kannst |
|---|---|
| Der Link bleibt am Dateianfang | Prüfe die Raute und vergleiche das Fragment mit dem Anker der gerenderten Überschrift. |
| Beide Einträge öffnen den ersten Abschnitt Examples | Kopiere den Anker der zweiten Überschrift. In der Vorlage endet er auf -1. |
| Ein Link funktioniert nach einer Änderung nicht mehr | Prüfe den Anker nach dem Umbenennen oder Verschieben einer Überschrift und aktualisiere die Verweise. |
| Ein Unterpunkt steht auf der falschen Ebene | Rücke die Aufzählung ein. Überschriftenebene und Listeneinzug werden getrennt festgelegt. |
| Der Link funktioniert nur auf einer Plattform | Ermittle den Anker auf der Plattform, auf der die Leser die Datei öffnen. |
Klicke nach einer Änderung alle Links in der gerenderten README an. Prüfe bei gleichnamigen Überschriften besonders genau, wo du landest. Für ein kurzes Verzeichnis genügen oft Einrichtung, Benutzung und Fehlerbehebung. Unterpunkte helfen bei längeren Abschnitten.
Das PNG unten wurde mit derselben Quelle aus Markdown2Image heruntergeladen. Es zeigt die Titelhierarchie und die eingerückte Liste. Für eine Folie zur Dokumentation kannst du den Link zur README neben das Bild setzen, damit Leser die Abschnitte öffnen können. Vorlage in Markdown2Image ansehen