Markdown-Spickzettel: die ganze Syntax, die Sie brauchen, mit Beispielen

Was ist Markdown?

Markdown ist eine schlanke Auszeichnungssprache, die John Gruber 2004 entwickelt hat. Das Ziel ist einfach: Text, der sich so wie er ist gut lesen lässt und sich sauber in HTML umwandeln lässt. Heute ist es der Standard für README-Dateien, Dokumentation, Entwicklerforen, Notiz-Apps wie Obsidian, Chat-Apps wie Slack und Discord und viele Blogplattformen.

Der verbreitetste Dialekt ist GitHub Flavored Markdown (GFM), das die ursprüngliche Syntax um Tabellen, Aufgabenlisten, Durchstreichen und automatische Links erweitert.

Überschriften

# Überschrift 1
## Überschrift 2
### Überschrift 3
#### Überschrift 4

Verwenden Sie nur eine #-Überschrift pro Dokument (den Titel) und halten Sie die Ebenen in der richtigen Reihenfolge. Setzen Sie nach dem # immer ein Leerzeichen.

Hervorhebung

Markdown	Ergebnis
**fett**	fett
*kursiv* oder _kursiv_	kursiv
***fett kursiv***	fett kursiv
~~durchgestrichen~~	durchgestrichen (GFM)
`Inline-Code`	Inline-Code

Links und Bilder

[Linktext](https://example.com)
[Link mit Titel](https://example.com "Text beim Überfahren")
<https://example.com>

![Alternativtext, der das Bild beschreibt](bild.png)

[Referenz-Link][docs]
[docs]: https://example.com/docs

Schreiben Sie aussagekräftige Alternativtexte für Bilder. Screenreader lesen sie vor, und sie helfen Suchmaschinen, das Bild zu verstehen.

Listen

- Aufzählungspunkt
- Noch ein Punkt
  - Verschachtelter Punkt (2 Leerzeichen einrücken)

1. Erster Schritt
2. Zweiter Schritt
3. Dritter Schritt

- [x] Erledigte Aufgabe
- [ ] Offene Aufgabe

Aufgabenlisten (- [ ]) gehören zu GFM und werden auf GitHub und in vielen Editoren als Kontrollkästchen angezeigt.

Zitate

> Das ist ein Zitat.
>
> Es kann mehrere Absätze umfassen.

Codeblöcke

```js
function greet(name) {
  return `Hallo, ${name}!`;
}
```

Umschließen Sie Code mit drei Backticks und geben Sie den Sprachnamen an (js, python, bash, json …), damit die Syntaxhervorhebung ihn einfärben kann.

Tabellen

| Tool          | Kategorie | Preis     |
| :------------ | :-------: | --------: |
| Zusammenfasser| Text      | Kostenlos |
| OCR           | Bilder    | Kostenlos |

Doppelpunkte in der Trennzeile legen die Ausrichtung fest: :--- links, :---: zentriert, ---: rechts. Die Spalten müssen im Quelltext nicht bündig sein, das erleichtert nur das Lesen.

Trennlinien und Zeilenumbrüche

Drei Bindestriche allein in einer Zeile ergeben eine Trennlinie:

---

Beenden Sie eine Zeile mit zwei Leerzeichen (oder einem Backslash)\
um innerhalb eines Absatzes einen Zeilenumbruch zu erzwingen.

Eine Leerzeile beginnt einen neuen Absatz. Die meisten Formatierungsprobleme entstehen durch fehlende Leerzeilen zwischen Absätzen, Listen und Überschriften.

Sonderzeichen maskieren

Um ein Zeichen anzuzeigen, das Markdown sonst interpretieren würde, setzen Sie einen Backslash davor: \*nicht kursiv\*, \#keine Überschrift, \[kein Link\].

Live ausprobieren und als HTML exportieren

1. Öffnen Sie den kostenlosen Markdown-zu-HTML-Editor.
2. Schreiben Sie Markdown oder nutzen Sie die Symbolleiste für Überschriften, Fett, Links, Listen, Tabellen und Code.
3. Die Vorschau aktualisiert sich beim Tippen. Wechseln Sie zum Reiter HTML, um den erzeugten Code zu sehen.
4. Kopieren Sie das HTML, laden Sie eine vollständige .html-Seite herunter oder speichern Sie Ihre .md-Datei.

Ihr Entwurf wird automatisch in Ihrem Browser gespeichert, und nichts wird hochgeladen.

Markdown-Tipps

• Leerzeilen lassen um Überschriften, Listen, Codeblöcke und Tabellen.
• Einheitlich bleiben: Wählen Sie - oder * für Aufzählungen und bleiben Sie dabei.
• Relative Links verwenden in Repositories ([Einrichtung](docs/setup.md)), damit sie in jedem Branch funktionieren.
• Vor dem Veröffentlichen prüfen. Plattformen unterscheiden sich leicht bei den unterstützten Erweiterungen.
• HTML nutzen, wenn nötig. Die meisten Markdown-Prozessoren akzeptieren Inline-HTML für Dinge, die Markdown nicht kann, etwa <kbd> oder <details>, manche Plattformen entfernen es aber aus Sicherheitsgründen.

Häufige Fragen

Was ist der Unterschied zwischen Markdown und GitHub Flavored Markdown?

GFM ist eine Erweiterung von Standard-Markdown (CommonMark) um Tabellen, Aufgabenlisten, Durchstreichen und automatische URL-Links.

Wie unterstreiche ich Text in Markdown?

Markdown hat keine Syntax zum Unterstreichen, weil unterstrichener Text wie ein Link aussieht. Wenn Sie es wirklich brauchen, nutzen Sie HTML: <u>Text</u>.

Wie füge ich einen Zeilenumbruch ohne neuen Absatz ein?

Beenden Sie die Zeile mit zwei Leerzeichen oder einem Backslash, oder verwenden Sie <br>.

Ist das exportierte HTML sicher für meine Website?

Ja. Das exportierte HTML ist sauberes, semantisches Markup ohne Inline-Styles, und die Vorschau wird bereinigt, um Skripte zu blockieren.

Fazit

Ein Dutzend Zeichen deckt fast alles ab, was Sie je in Markdown schreiben. Halten Sie diesen Spickzettel griffbereit, lassen Sie Leerzeilen zwischen Blöcken und prüfen Sie Ihren Text vor dem Veröffentlichen in der Vorschau.