Die Grundlagen in einer Tabelle
Markdown wurde so entworfen, dass eine Textdatei schon vor der Umwandlung lesbar bleibt. Eine Überschrift sieht wie eine Überschrift aus, weil sie mit einer Raute beginnt, und eine Liste wie eine Liste, weil jede Zeile mit einem Bindestrich anfängt. Wird der Text auf GitHub, in einer Notiz-App oder im Editor unten angezeigt, werden aus den Zeichen echte Formatierungen.
Die Tabelle enthält die Zeichen, die du am häufigsten brauchst. Kopiere ein Beispiel in den Editor, um zu sehen, was daraus wird.
| Element | Schreibweise | Ergebnis |
|---|---|---|
| Überschrift Ebene 1 bis 6 | # Titel, ## Abschnitt, ### Unterabschnitt | Überschriften in abnehmender Größe |
| Fett | **fett** oder __fett__ | fetter Text |
| Kursiv | *kursiv* oder _kursiv_ | kursiver Text |
| Fett und kursiv | ***beides*** | fett und kursiv |
| Durchgestrichen | ~~alter Preis~~ | durchgestrichener Text |
| Code im Text | `npm install` | Code in Festbreitenschrift |
| Link | [Anyfeat](https://anyfeat.com) | anklickbarer Text |
| Bild |  | ein Bild mit Alternativtext |
| Aufzählung | - Punkt (oder * Punkt, + Punkt) | ein Aufzählungspunkt |
| Nummerierte Liste | 1. erstens | ein nummerierter Eintrag |
| Aufgabenliste | - [ ] offen und - [x] erledigt | Kontrollkästchen |
| Zitat | > zitierter Text | ein eingerücktes Zitat |
| Trennlinie | *** allein in einer Zeile | eine waagerechte Linie |
Hier ausprobieren: Markdown-Editor
Vollständige Tool-Seite öffnenÜberschriften, Absätze und Zeilenumbrüche
Beginne eine Zeile mit einer bis sechs Rauten und einem Leerzeichen, um eine Überschrift zu erstellen. Die Zahl der Rauten ist die Ebene. Die meisten Dokumente haben eine Überschrift der Ebene 1 als Titel und Überschriften der Ebenen 2 und 3 für Abschnitte. Der häufigste Fehler ist das fehlende Leerzeichen nach der Raute: #Titel bleibt auf GitHub einfacher Text.
Ein Absatz besteht aus einer oder mehreren Textzeilen und wird durch eine Leerzeile vom nächsten Absatz getrennt. Ein einzelner Zeilenumbruch innerhalb eines Absatzes wird bei der Umwandlung ignoriert, was viele überrascht. Um einen Zeilenumbruch zu erzwingen, beende die Zeile mit zwei Leerzeichen oder einem Backslash. GitHub-Kommentare und manche Chat-Apps behandeln jeden Zeilenumbruch als Umbruch. Im Editor oben bekommst du dasselbe Verhalten mit Zeilenumbrüche wie in GitHub-Kommentaren.
Auf GitHub und im Editor oben bekommt jede Überschrift außerdem einen Anker, eine kleingeschriebene Fassung ihres Texts, bei der Leerzeichen zu Bindestrichen werden. Eine Überschrift Erste Schritte lässt sich mit [zur Einrichtung](#erste-schritte) verlinken. So funktionieren Inhaltsverzeichnisse in README-Dateien.
Listen und Aufgabenlisten
Aufzählungen beginnen jede Zeile mit einem Bindestrich, einem Sternchen oder einem Pluszeichen und einem Leerzeichen. Nummerierte Listen verwenden eine Zahl und einen Punkt. Die Zahlen müssen nicht stimmen: Eine Liste, die als 1. 1. 1. geschrieben ist, wird trotzdem als 1, 2, 3 angezeigt. Die erste Zahl zählt aber, eine Liste, die mit 3. beginnt, startet also bei 3.
Um eine Liste zu verschachteln, rückst du die inneren Einträge so ein, dass sie mit dem Text des Eintrags darüber auf einer Linie stehen. Das sind zwei Leerzeichen unter einem Bindestrich und drei unter 1. In den meisten Tools funktionieren auch vier Leerzeichen. Eine Leerzeile zwischen den Einträgen ergibt eine lockere Liste mit mehr Abstand, ohne Leerzeilen bleibt die Liste kompakt.
Aufgabenlisten sind eine GitHub-Erweiterung: Schreib - [ ] für eine offene Aufgabe und - [x] für eine erledigte. Daraus werden Kontrollkästchen. Im Editor auf dieser Seite kannst du ein Kästchen in der Vorschau anhaken, und aus [ ] in deinem Text wird [x].
Links, Bilder und Verweise
Ein Link besteht aus dem sichtbaren Text in eckigen Klammern und der Adresse in runden Klammern: [Anyfeat](https://anyfeat.com). Ein Titel, der beim Darüberfahren erscheint, steht in Anführungszeichen nach der Adresse. Eine Adresse in spitzen Klammern wie <https://anyfeat.com> wird zu einem Link, der die Adresse selbst zeigt, und auf GitHub werden einfache Adressen, die mit https:// oder www. beginnen, automatisch verlinkt.
Bilder folgen demselben Muster mit einem Ausrufezeichen davor: . Der Text in den Klammern ist der Alternativtext, den Screenreader vorlesen und der erscheint, wenn das Bild nicht lädt. Beschreibe also, was auf dem Bild zu sehen ist.
In langen Dokumenten halten Referenzlinks den Text lesbar: Schreib [die Anleitung][1] in den Text und setz [1]: https://example.com in eine eigene Zeile irgendwo in der Datei. Die Definitionszeile selbst erscheint nicht im Ergebnis.
Tabellen
Tabellen gehören zu GitHub Flavored Markdown und funktionieren auf GitHub, GitLab, in den meisten Dokumentationstools und im Editor oben, aber nicht in jeder Markdown-App. Schreib die Kopfzellen getrennt durch senkrechte Striche, darunter eine Trennzeile mit Bindestrichen und danach eine Zeile pro Tabellenzeile:
| Tarif | Preis |, dann |:-|-:|, dann | Team | 49 |. Jede Zelle der Trennzeile braucht mindestens einen Bindestrich, üblich sind drei, weil sie besser lesbar sind. Ein Doppelpunkt links von den Bindestrichen richtet die Spalte links aus, Doppelpunkte auf beiden Seiten zentrieren sie, und ein Doppelpunkt rechts richtet sie rechts aus, was zu Zahlen passt.
Die Striche müssen nicht untereinander stehen, und die äußeren Striche sind optional. Für einen senkrechten Strich innerhalb einer Zelle schreibst du \|. Zeilenumbrüche in einer Zelle sind in Markdown selbst nicht möglich, nutze <br>, wo HTML erlaubt ist. Der Knopf Tabelle im Editor fügt eine fertige Tabelle mit drei Spalten ein, die du ausfüllen kannst.
Code und Zitate
Für ein kurzes Stück Code in einem Satz setzt du es in einfache Backticks: `git status`. Für mehrere Zeilen schreibst du drei Backticks in die Zeile vor und nach dem Code. Ein Sprachname direkt nach den öffnenden Backticks, etwa js, python oder sql, lässt GitHub und Syntax-Highlighter den Code einfärben. Der Editor auf dieser Seite behält ihn im exportierten HTML als Klasse am code-Element. Zeilen, die um vier Leerzeichen eingerückt sind, werden ebenfalls als Code angezeigt.
Alles in Code wird genau so angezeigt, wie es getippt wurde. Dort gehören also Zeichen hin, die Markdown sonst auswerten würde, etwa Sternchen und Unterstriche. Außerhalb von Code setzt du einen Backslash vor ein Zeichen, um es wörtlich zu zeigen: \* ergibt ein einfaches Sternchen.
Zitate beginnen mit > und können anderes Markdown enthalten, auch Listen und weitere Zitate mit >>. Sie werden für Zitate, Hinweise und Antworten in Diskussionen genutzt.
Unterschiede zwischen Markdown-Apps
Die Grundsyntax oben funktioniert fast überall. Die Unterschiede liegen in den Erweiterungen: GitHub unterstützt Tabellen, Aufgabenlisten, Durchstreichen, automatische Links und Hinweisboxen, die als > [!NOTE] geschrieben werden. Obsidian ergänzt Links zwischen Notizen in doppelten eckigen Klammern, und manche Tools unterstützen Fußnoten und mathematische Formeln. Der Editor auf dieser Seite folgt GitHub bei Tabellen, Aufgabenlisten, Durchstreichen, automatischen Links und Überschriftenankern, unterstützt aber keine Fußnoten, Formeln oder Hinweisboxen.
Die meisten Markdown-Apps akzeptieren auch etwas HTML. Tags wie <br>, <sub>, <sup>, <kbd> und <details> funktionieren im Editor oben, während Skripte, Styles und Event-Attribute immer entfernt werden, genau wie auf GitHub.