Fußnoten in Markdown

Eine Fußnote sind zwei Hälften, die sich über einen Namen finden: eine Marke im Text und eine Definition irgendwo sonst im Dokument. Der Renderer sammelt die Definitionen ein, nummeriert sie in der Reihenfolge, in der die Marken auftauchen, und setzt sie mit einem Rücklink ans Seitenende.

Beachte: Das ist eine Erweiterung, kein Teil des ursprünglichen Markdown, die Unterstützung schwankt also. Das Vorschaupanel unten setzt Fußnoten als wörtlichen Text — und genau das siehst du in einem Parser, der sie nicht kennt. Einmal angeschaut zu haben, wie das aussieht, ist nützlich.

Markdown entstand 2004.[^1] Es wurde entworfen, um als
reiner Text lesbar zu sein.[^entwurf]

[^1]: Von John Gruber, mit Beiträgen von Aaron Swartz.
[^entwurf]: „Ein Markdown-Dokument soll so, wie es ist,
    als reiner Text veröffentlichbar sein."

Die Syntax

Eine Behauptung, die eine Quelle braucht.[^1]

[^1]: Die Quelle.

• Die Marke ist [^name], inline dort, wo die Zahl erscheinen soll.
• Die Definition ist [^name]: Text, auf einer eigenen Zeile.
• Der Name ist nicht die Zahl. [^gruber] ist völlig gültig und erscheint als 1, wenn es die erste Fußnote im Dokument ist. Nimm Wörter — sie überstehen ein Umsortieren, während [^1], [^2], [^3] neu nummeriert werden müssen, sobald du eine einfügst.

Definitionen dürfen überall stehen. Sie ans Ende zu setzen ist üblich; jede direkt unter den Absatz zu setzen, der sie referenziert, ist in einem langen Dokument deutlich pflegeleichter. Die Ausgabe ist in beiden Fällen identisch.

Fußnoten über mehrere Absätze

Rück die Fortsetzung um vier Leerzeichen ein:

Hier steht die Behauptung.[^lang]

[^lang]: Der erste Absatz der Notiz.

    Der zweite Absatz, um vier Leerzeichen eingerückt.

Der zweite Absatz, um vier Leerzeichen eingerückt.

Wo Fußnoten funktionieren

Sie stehen nicht in CommonMark, das ist also eine Frage der Kompatibilität:

• Unterstützt: die meisten Generatoren für statische Seiten, die meisten Notiz- und Markdown-Editor-Apps, pandoc und der Großteil der Werkzeuge, die nach PDF oder EPUB exportieren.
• Nicht unterstützt: .md-Dateien in der Repository-Ansicht von GitHub haben sie lange ignoriert, wobei GitHub sie inzwischen in den meisten Zusammenhängen unterstützt. Minimale Parser und viele Vorschau-Widgets im Web können sie weiterhin nicht.

Kann das Ziel sie nicht, erscheinen die Marken als wörtliches [^1] im Text und die Definitionen als gewöhnliche Absätze — sichtbar, hässlich, aber nicht zerstörerisch.

Wann Fußnoten das falsche Werkzeug sind

Fußnoten passen zu langen Texten: Aufsätze, Arbeiten, Dokumentation mit Belegen. Zu einer README passen sie schlecht. Ist die Notiz kurz und unmittelbar nützlich, liest sich eine Klammer im Satz besser, als jemanden ans Seitenende und wieder zurück zu schicken.

Der gute Test: Muss die lesende Person die Notiz lesen, um dem Argument zu folgen, ist es keine Fußnote — dann gehört sie in den Satz.

Die portable Alternative

Wo Fußnoten nicht unterstützt werden, erledigt ein Abschnitt am Ende plus Ankerlinks dieselbe Aufgabe mit universeller Syntax:

Eine Behauptung.[<sup>1</sup>](#notiz-1)

## Notizen

<a id="notiz-1"></a>1. Die Quelle.

Das kostet rohes HTML für den Anker und ist mehr Arbeit. Nimm es nur, wenn du weißt, dass dem Ziel die Fußnoten fehlen.

Häufige Fehler

Eine Fußnote definieren, die nie referenziert wird. Die meisten Renderer lassen sie stillschweigend fallen. Deine Notiz verschwindet ohne Warnung aus der Ausgabe.

Einen Namen referenzieren, den es nicht gibt. Die Marke erscheint als wörtlicher Text [^1].

Von Hand nummerieren. Der Name ist nicht die Zahl. Nimm Wörter und lass den Renderer zählen.

Fortsetzung um zwei Leerzeichen eingerückt. Fußnoten-Fortsetzungen brauchen vier, anders als Listenpunkte.

Annehmen, dass sie überall funktionieren. Prüf dein Ziel, bevor du fünfzig davon schreibst.

Häufige Fragen

Wie füge ich in Markdown eine Fußnote ein?

Setz [^name] dorthin, wo die Marke erscheinen soll, und [^name]: deine Notiz auf eine eigene Zeile irgendwo im Dokument. Der Renderer nummeriert die Marken in der Reihenfolge ihres Auftretens und sammelt die Notizen unten ein.

Muss der Name der Fußnote eine Zahl sein?

Nein, und es ist besser, wenn er es nicht ist. [^gruber] funktioniert und erscheint mit der Zahl, die seine Position verlangt. Wortnamen überstehen ein Umsortieren; numerische müssen von Hand neu nummeriert werden.

Funktionieren Fußnoten auf GitHub?

In den meisten Zusammenhängen inzwischen ja — historisch wurden sie in der Dateiansicht eines Repositories aber ignoriert, und viele minimale Parser können sie weiterhin nicht. Wo sie fehlen, erscheinen die Marken als wörtlicher Text [^1].

Wie schreibe ich eine Fußnote über mehrere Absätze?

Rück jeden Folgeabsatz unter der Definition um vier Leerzeichen ein. Alles, was so weit eingerückt ist, gehört zur Fußnote.

Gehören Fußnoten zum Standard-Markdown?

Nein. Sie sind eine Erweiterung und fehlen sowohl in der ursprünglichen Syntax von 2004 als auch in CommonMark, sind aber von Generatoren für statische Seiten, Editoren und Dokumentkonvertern breit umgesetzt.