Markdown Syntax Guide: Von den Grundlagen bis Fortgeschritten

Was ist Markdown und Warum Sollte Man Es Verwenden?

Markdown ist eine leichtgewichtige Auszeichnungssprache, die 2004 von John Gruber und Aaron Swartz entwickelt wurde. Das Ziel: Text formatieren, ohne dass der Quelltext durch HTML-Tags unlesbar wird.

Markdown hat sich durchgesetzt, weil es einfach zu lernen und universell einsetzbar ist. Es wird verwendet in:

• GitHub und GitLab: README-Dateien, Issues, Pull Requests und Wikis verwenden Markdown.
• Dokumentation: Technische Dokumentation (MkDocs, Docusaurus, VuePress) basiert fast immer auf Markdown.
• Blogs und CMS: Hugo, Jekyll, Gatsby und viele andere Static-Site-Generatoren verwenden Markdown für Inhalte.
• Notiz-Apps: Obsidian, Notion, Bear und Typora verwenden Markdown als Basis.
• Chat-Plattformen: Slack, Discord und Teams unterstützen Markdown-Formatierung in Nachrichten.

Testen Sie Ihre Markdown-Texte direkt in unserem Markdown Vorschau-Tool — mit Echtzeit-Rendering und Export-Funktionen.

Grundlegende Syntax: Überschriften, Text und Listen

Überschriften: Verwenden Sie #-Zeichen am Zeilenanfang. Die Anzahl bestimmt die Ebene:

• # Überschrift 1 — Hauptüberschrift (H1). Nur einmal pro Dokument verwenden.
• ## Überschrift 2 — Abschnittsüberschrift (H2).
• ### Überschrift 3 — Unterabschnitt (H3). Bis zu ###### (H6) möglich.

Textformatierung:

• **fett** oder __fett__ — Fetter Text.
• *kursiv* oder _kursiv_ — Kursiver Text.
• ***fett und kursiv*** — Beides kombiniert.
• ~~durchgestrichen~~ — Durchgestrichener Text.
• `Code` — Inline-Code mit Monospace-Schrift.

Listen:

• Ungeordnete Listen: Zeile mit -, * oder + beginnen.
• Geordnete Listen: Zeile mit 1., 2. etc. beginnen. Die Nummerierung muss nicht stimmen — Markdown nummeriert automatisch.
• Verschachtelung: 2 oder 4 Leerzeichen Einrückung für Unterlisten.

Links, Bilder und Zitate

Links:

• Inline-Link: [Linktext](https://example.com).
• Link mit Titel: [Linktext](https://example.com "Titel"). Der Titel erscheint beim Hovern.
• Referenz-Link: [Linktext][ref] und an anderer Stelle [ref]: https://example.com. Nützlich für häufig verwendete URLs.
• Automatische Links: <https://example.com> wird direkt klickbar.

Bilder:

• Inline-Bild: ![Alternativtext](bild.jpg).
• Bild mit Titel: ![Alternativtext](bild.jpg "Bildtitel").
• Bildgrösse: Standard-Markdown unterstützt keine Grössenangaben. In GitHub Flavored Markdown und einigen Implementierungen funktioniert HTML: <img src="bild.jpg" width="300">.

Blockzitate:

• > Dies ist ein Zitat. — Wird eingerückt und optisch hervorgehoben dargestellt.
• Verschachtelung: > > Verschachteltes Zitat.
• Innerhalb von Blockzitaten funktionieren alle anderen Markdown-Elemente.

Code-Blöcke und Syntax-Highlighting

Inline-Code: Umschliessen Sie Code mit einfachen Backticks: `const x = 42;`.

Code-Blöcke: Verwenden Sie drei Backticks mit optionaler Sprachbezeichnung für Syntax-Highlighting:

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

Gängige Sprachbezeichnungen: javascript, python, html, css, bash, json, sql, typescript, java, csharp.

Eingerückte Code-Blöcke: Alternativ können Sie Code mit 4 Leerzeichen oder einem Tab einrücken. Diese Methode unterstützt aber kein Syntax-Highlighting und ist weniger eindeutig — bevorzugen Sie die Backtick-Variante.

Tabellen und Erweiterte Syntax

Tabellen: Tabellen werden mit Pipe-Zeichen (|) und Bindestrichen (-) erstellt:

| Spalte 1 | Spalte 2 | Spalte 3 |
|----------|:--------:|---------:|
| Links | Zentriert | Rechts |
| Daten | Daten | Daten |

Die Doppelpunkte in der Trennzeile bestimmen die Ausrichtung: links (Standard), zentriert (:---:) oder rechts (---:).

Horizontale Linie: Drei oder mehr Bindestriche, Sternchen oder Unterstriche auf einer eigenen Zeile: --- oder ***.

Aufgabenlisten (GitHub Flavored Markdown):

• - [ ] Nicht erledigt — Offene Aufgabe.
• - [x] Erledigt — Abgeschlossene Aufgabe.

Fussnoten:

• Text mit Fussnote[^1]. und [^1]: Erklärung der Fussnote.

Tipps, Tricks und Werkzeuge

Einige nützliche Hinweise für den Alltag mit Markdown:

• Zeilenumbrüche: Ein einfacher Zeilenumbruch im Quelltext wird ignoriert. Für einen harten Zeilenumbruch setzen Sie zwei Leerzeichen am Zeilenende oder eine leere Zeile für einen neuen Absatz.
• Sonderzeichen escapen: Wenn Sie ein Markdown-Sonderzeichen wörtlich verwenden möchten, setzen Sie einen Backslash davor: \*kein kursiv\*.
• HTML ist erlaubt: In den meisten Markdown-Implementierungen können Sie HTML direkt einbetten. Das ist nützlich für Elemente, die Markdown nicht abdeckt (z.B. <details>-Tags für aufklappbare Abschnitte).
• Konsistenz: Wählen Sie einen Stil (z.B. - oder * für Listen) und bleiben Sie dabei. Mischen verwirrt Leser und Linting-Tools.

Probieren Sie Ihre Markdown-Texte direkt aus mit unserem kostenlosen Markdown Vorschau-Tool — Echtzeit-Rendering, Export als HTML und druckfertige Vorschau.