Markdown-Spickzettel

Schritt 1 / 3 33%

Markdown-Thema auswählen

Beginnen Sie mit einer Beispielgruppe und öffnen Sie danach die vollständige Referenz.

Wichtige Markdown-Syntax, nach Kategorien geordnet und mit kopierfertigem Quelltext sowie der Ausgabe eines echten Parsers. Enthalten sind CommonMark-Grundlagen (Überschriften, Listen, Hervorhebung, Links, Bilder und eingezäunter Code) und Erweiterungen von GitHub Flavored Markdown (Tabellen, Aufgabenlisten, Durchstreichungen und automatische Verlinkung unformatierter URLs). Praktisch beim Wechsel zwischen GitHub, GitLab, Obsidian und Generatoren für statische Websites.

So verwendest du den Spickzettel

  1. 1

    Nach Kategorie durchsuchen

    Filtern Sie die vollständige Referenz oder wählen Sie in der geführten Ansicht ein Thema aus.

  2. 2

    Vergleiche Quelle und Ergebnis

    Jedes Beispiel zeigt den Markdown-Quelltext neben der Ausgabe eines echten GFM-Parsers.

  3. 3

    Snippet kopieren

    Tippe auf Kopieren, um den Quelltext für jedes Beispiel zu erhalten.

  4. 4

    Syntaxkennzeichnung prüfen

    Jedes Beispiel ist als CommonMark oder GitHub Flavored Markdown (GFM) gekennzeichnet.

Überschriften

# H1-Titel
## H2-Abschnitt
### H3-Unterabschnitt

Verwende den ATX-Stil (#) anstelle von Setext (=== unter dem Text). Jeder Parser unterstützt beides, aber ATX ist in einem Diff leichter zu lesen.

Betonung

*kursiv* oder _kursiv_, **fett** oder __fett__, ***fett kursiv***. GFM fügt ~~Durchstreichung~~ hinzu.

Listen

Ungeordnete Listen verwenden -, * oder + (wähle eines und bleibe dabei):

- Erster
- Zweiter
  - Verschachtelt (zwei Leerzeichen)

Geordnete Listen nummerieren automatisch neu:

1. Element
1. Element
1. Element

Code

Inline: `code`. Eingezäunte Blöcke mit optionalem Sprach-Tag:

```python
def hello(name):
    return f"Hallo, {name}"
```

Rücke mit vier Leerzeichen für einen Codeblock ein, wenn du die ältere Syntax bevorzugst.

Links und Bilder

[Linktext](https://example.com)
[Link mit Titel](https://example.com "Tooltip")
![Alternativtext](/path/to/image.png)

Referenzstil hält lange URLs aus dem Absatz heraus:

Siehe die [Dokumentation][1].

[1]: https://example.com/docs

Tabellen (GFM)

| Spalte A | Spalte B |
|-------|------:|
| a     |     1 |
| b     |    22 |

Ausrichtung verwendet Doppelpunkte in der Trennzeile: :--- links, :---: zentriert, ---: rechts.

Aufgabenlisten (GFM)

- [x] Erledigt
- [ ] Zu erledigen

Häufige Fallstricke

  • Zwei nachgestellte Leerzeichen fügen einen Zeilenumbruch innerhalb eines Absatzes ein. Ein Leerzeichen verbindet nur die Zeilen.
  • Leerzeile erforderlich vor den meisten Blockelementen (Überschriften, Listen, Codeblöcke).
  • Listenmarkierungen nicht mit Tabs einrücken, wenn dein Renderer Leerzeichen erwartet; rücke mit zwei oder vier Leerzeichen ein.
  • Mit Backslash escapen für literale Interpunktion: \*nicht kursiv\*.
  • Intelligente Anführungszeichen unterscheiden sich je nach Renderer. GitHub lässt sie in Ruhe; Pandoc konvertiert.

Häufig gestellte Fragen

CommonMark definiert den portablen Kern, darunter Überschriften, Listen, Links und eingezäunten Code mit optionaler Info-Angabe. GFM ergänzt Tabellen, Aufgabenlisten, Durchstreichungen und automatische Links für unformatierte URLs. Andere Editoren können nur einen Teil unterstützen oder eigene Erweiterungen hinzufügen.

In einer Markdown-Datei ist ein einzelner Zeilenumbruch normalerweise weich. Für einen harten Umbruch in CommonMark oder GFM endet die erste Zeile mit zwei Leerzeichen oder einem umgekehrten Schrägstrich.

CommonMark erkennt rohes HTML, doch die Plattform entscheidet, ob es zugelassen, bereinigt oder maskiert wird. GitHub bereinigt gerendertes HTML; dieser Spickzettel maskiert HTML in Vorschauen aus Sicherheitsgründen.

CommonMark besitzt keine eingebaute Syntax für Inhaltsverzeichnisse. GitHub erzeugt Überschriftenanker und zeigt bei Dateien mit mehreren Überschriften eine Gliederung. Andere Plattformen regeln dies selbst: MkDocs kann mit aktivierter TOC-Erweiterung [TOC] verwenden, Docusaurus leitet das Seiteninhaltsverzeichnis aus Überschriften ab.

Die CommonMark-Beispiele und viele GFM-Beispiele funktionieren. Obsidian unterstützt zusätzlich eigene Wikilinks ([[Seitenname]]), Callouts und Einbettungen; diese Erweiterungen gehören nicht zu diesem Spickzettel.

Verwandte Tools