Markdown-Spickzettel

Der Markdown-Spickzettel listet die Markdown-Syntax mit Ergebnis: Formatierung, Überschriften, Listen, Links, Bilder, Code, Tabellen und GitHub-Erweiterungen, durchsuchbar und kopierbar.

Textformatierung

**fett**
Fett mit zwei Sternchen.
fett
__fett__
Fett mit zwei Unterstrichen; mitten im Wort funktioniert nur die Sternchen-Variante.
fett
*kursiv*
Kursiv mit einem Sternchen.
kursiv
_kursiv_
Kursiv mit einem Unterstrich.
kursiv
***fett und kursiv***
Drei Sternchen kombinieren beides.
fett und kursiv
~~durchgestrichen~~
Durchgestrichen (GitHub Flavored Markdown, nicht im ursprünglichen Markdown).
durchgestrichen
`Code im Text`
Inline-Code in Backticks, wird in Festbreitenschrift gezeigt.
Code im Text
Zeile eins Zeile zwei
Zeilenumbruch im Absatz: zwei Leerzeichen am Zeilenende oder ein Backslash.
Zeile eins
Zeile zwei
\*kein Kursiv\*
Backslash escapt Sonderzeichen wie * _ ` # [ ] ( ) und |.
*kein Kursiv*
H<sub>2</sub>O und x<sup>2</sup>
Tief- und Hochstellung über HTML-Tags; die meisten Renderer erlauben sie.
H2O und x2
<kbd>Strg</kbd> + <kbd>C</kbd>
Tastenkombinationen mit dem HTML-Tag kbd.
Strg + C

Überschriften

# Überschrift 1
Ebene 1, meist der Dokumenttitel. Leerzeichen nach der Raute ist Pflicht.
Überschrift 1
## Überschrift 2
Ebene 2.
Überschrift 2
### Überschrift 3
Ebene 3.
Überschrift 3
#### Überschrift 4
Ebene 4; es gibt bis zu sechs Ebenen (######).
Überschrift 4
Überschrift ==========
Setext-Stil für Ebene 1: Gleichheitszeichen in der Zeile darunter.
Überschrift
Überschrift ----------
Setext-Stil für Ebene 2: Bindestriche in der Zeile darunter.
Überschrift

Listen

- Punkt - Punkt
Aufzählung mit Bindestrich; * und + funktionieren ebenso.
  • Punkt
  • Punkt
1. Erster 2. Zweiter
Nummerierte Liste. Die Zahlen müssen nicht stimmen, gezählt wird automatisch.
  1. Erster
  2. Zweiter
3. Start bei drei 4. weiter
Die erste Zahl legt den Startwert fest.
  1. Start bei drei
  2. weiter
- Obst - Apfel - Birne
Verschachtelte Liste: Unterpunkte so weit einrücken, dass sie unter dem Text des Elternpunkts beginnen (hier zwei Leerzeichen).
  • Obst
    • Apfel
    • Birne
- Punkt Zweiter Absatz
Mehrere Absätze in einem Listenpunkt: Leerzeile und Einrückung.
  • Punkt

    Zweiter Absatz

- [ ] offen - [x] erledigt
Aufgabenliste mit Checkboxen (GitHub Flavored Markdown).
  • ☐ offen
  • ☑ erledigt

Links und Bilder

[Linktext](https://example.com)
Link mit sichtbarem Text.
Linktext
[Linktext](https://example.com "Titel")
Link mit Titel, der beim Überfahren erscheint.
Linktext
<https://example.com>
Automatischer Link: Adresse in spitzen Klammern.
https://example.com
<info@example.com>
E-Mail-Adresse als Link.
info@example.com
[Text][ref] [ref]: https://example.com
Referenzlink: Adresse steht getrennt, oft am Ende des Dokuments.
Text
[Zum Abschnitt](#installation)
Sprungmarke auf eine Überschrift im selben Dokument. Der Anker ist die Überschrift in Kleinbuchstaben, Leerzeichen als Bindestrich.
Zum Abschnitt
![Alternativtext](bild.png)
Bild einbinden. Der Alternativtext beschreibt das Bild für Screenreader.
[Bild: Alternativtext]
[![Alt](bild.png)](https://example.com)
Bild als Link: Bild-Syntax in die eckigen Klammern eines Links setzen.
[Bild: Alt]

Code

``` Code-Block ```
Code-Block mit drei Backticks (Fenced Code Block).
Code-Block
```js const x = 1; ```
Sprache nach den Backticks angeben, damit die Syntax hervorgehoben wird.
const x = 1;
~~~ Code ~~~
Alternative mit Tilden, praktisch wenn der Code selbst Backticks enthält.
Code
eingerückter Code
Vier Leerzeichen Einrückung erzeugen ebenfalls einen Code-Block (nicht innerhalb von Listen).
eingerückter Code
`` a ` b ``
Backtick im Inline-Code: mit doppelten Backticks umschließen.
a ` b
```diff - alt + neu ```
Diff-Block: Zeilen mit - und + werden auf GitHub rot und grün markiert.
- alt
+ neu

Tabellen

| Name | Wert | | ---- | ---- | | A | 1 |
Markdown Tabelle: Kopfzeile, Trennzeile mit Bindestrichen, dann Datenzeilen (GitHub Flavored Markdown).
NameWert
A1
| Links | Mitte | Rechts | | :---- | :---: | -----: | | a | b | c |
Ausrichtung über Doppelpunkte in der Trennzeile.
LinksMitteRechts
abc
| Befehl | Bedeutung | | --- | --- | | `a \| b` | Pipe im Text |
Senkrechten Strich in einer Zelle mit Backslash escapen. Mehrzeilige Zellen gibt es nicht, nur br-Tags.
BefehlBedeutung
a | bPipe im Text

Zitate, Linien und Absätze

> Zitat
Blockzitat mit spitzer Klammer.
Zitat
> Ebene 1 >> Ebene 2
Verschachteltes Zitat.
Ebene 1
Ebene 2
---
Horizontale Linie; auch *** oder ___. Davor eine Leerzeile, sonst wird die Zeile darüber zur Überschrift.

Absatz eins Absatz zwei
Absätze trennt eine Leerzeile; ein einfacher Zeilenumbruch erzeugt keinen neuen Absatz.

Absatz eins

Absatz zwei

<!-- Kommentar -->
HTML-Kommentar: erscheint nicht in der Ausgabe.
(nicht sichtbar)
<details> <summary>Mehr</summary> Versteckter Text </details>
Aufklappbarer Bereich über HTML, funktioniert auf GitHub und in vielen Renderern.
MehrVersteckter Text

GitHub-Erweiterungen

Text[^1] [^1]: Fußnote
Fußnote (GitHub, viele Static-Site-Generatoren).
Text1
> [!NOTE] > Hinweis
Hinweisblock auf GitHub. Weitere Typen: TIP, IMPORTANT, WARNING, CAUTION.
Note
Hinweis
www.example.com
Erweiterter Autolink: Adressen mit www. oder https:// werden auf GitHub ohne Klammern verlinkt.
www.example.com
@benutzername
Erwähnung einer Person oder eines Teams auf GitHub.
@benutzername
#123
Verweis auf Issue oder Pull Request Nummer 123 im selben Repository.
#123
:tada:
Emoji-Kürzel auf GitHub, Slack und anderen; wird dort als Bildzeichen dargestellt.
(Bildzeichen)
$E = mc^2$
Mathematische Formel inline (LaTeX) auf GitHub; Blöcke mit $$ … $$.
E = mc²
```mermaid graph LR A --> B ```
Diagramm aus Text mit Mermaid, auf GitHub und GitLab direkt dargestellt.
(Diagramm A → B)

Alles läuft in Ihrem Browser. Eingaben verlassen Ihr Gerät nicht.

Markdown Syntax mit Ergebnis

Der Markdown-Spickzettel zeigt jede Schreibweise zusammen mit dem Ergebnis: Textformatierung wie fett und kursiv, Überschriften, Listen, Links, Bilder, Code-Blöcke, Zitate und die Markdown Tabelle. Jede Zeile lässt sich kopieren und direkt in README-Dateien, Wikis, Issues oder Notiz-Apps einfügen. So ist dieses Markdown Cheat Sheet auch als schnelle Erinnerung für die seltenen Fälle gedacht, etwa Fußnoten, verschachtelte Listen oder Pipes in Tabellenzellen.

Markdown gibt es in mehreren Varianten. Die Grundlage bildet CommonMark; GitHub Flavored Markdown (GFM) ergänzt Tabellen, Aufgabenlisten, Durchstreichen und automatische Links. GitHub selbst kennt außerdem Hinweisblöcke, Fußnoten, Mathe und Mermaid-Diagramme; diese stehen in der eigenen Gruppe, weil andere Programme sie nicht immer darstellen. Die Markdown Syntax für Überschriften, Hervorhebung und Listen funktioniert dagegen fast überall gleich.

Ein typischer Stolperstein der Markdown Formatierung: Ein einfacher Zeilenumbruch erzeugt keinen neuen Absatz, dafür braucht es eine Leerzeile. Ebenso muss nach der Raute einer Überschrift ein Leerzeichen stehen. Wenn Sie Tabellen aus Excel übernehmen möchten, hilft Tabelle umwandeln; Markdown in andere Formate bringt Markdown umwandeln.

Anleitung: Markdown Spickzettel in 3 Schritten

  1. Im Feld „Suchen“ ein Stichwort wie Tabelle, Link oder Checkbox eingeben.
  2. Über „Gruppe“ auf einen Bereich wie Listen, Code oder GitHub-Erweiterungen einschränken.
  3. Syntax und Ergebnis vergleichen und den Baustein mit „Kopieren“ in die eigene Datei übernehmen.

Typische Anwendungsfälle

  • README-Dateien und Wiki-Seiten auf GitHub oder GitLab schreiben.
  • Notizen in Obsidian oder anderen Markdown-Editoren formatieren.
  • Prompts für ChatGPT oder Claude mit Überschriften, Listen und Codeblöcken gliedern.
  • Hinweisblöcke, Aufgabenlisten und Fußnoten in Issues und Pull Requests nutzen.
Fragen

Häufige Fragen

Wie erstelle ich eine Markdown Tabelle?

Schreiben Sie die Kopfzeile mit senkrechten Strichen zwischen den Spalten, darunter eine Trennzeile mit mindestens drei Bindestrichen je Spalte und danach die Datenzeilen. Doppelpunkte in der Trennzeile legen die Ausrichtung fest. Tabellen gehören zu GitHub Flavored Markdown und werden von den meisten Programmen unterstützt.

Warum wird mein Zeilenumbruch nicht angezeigt?

In Markdown verbindet ein einzelner Zeilenumbruch die Zeilen zu einem Absatz. Für einen sichtbaren Umbruch setzen Sie zwei Leerzeichen oder einen Backslash ans Zeilenende, für einen neuen Absatz eine Leerzeile.

Was ist GitHub Flavored Markdown?

Die Markdown-Variante von GitHub auf Basis von CommonMark. Sie ergänzt Tabellen, Aufgabenlisten mit Checkboxen, Durchstreichen mit Tilden und automatische Links. Darüber hinaus kennt GitHub Hinweisblöcke, Fußnoten, Mathe-Formeln und Mermaid-Diagramme.

Kann ich HTML in Markdown verwenden?

Ja, die meisten Renderer erlauben einfache HTML-Tags wie sub, sup, kbd, br oder details. Plattformen wie GitHub filtern aber Skripte, Styles und viele Attribute aus Sicherheitsgründen heraus.

Wie setze ich einen Link auf eine Überschrift?

Mit einem Anker: [Text](#name-der-ueberschrift). Auf GitHub entsteht der Anker aus der Überschrift in Kleinbuchstaben, Leerzeichen werden zu Bindestrichen, die meisten Satzzeichen fallen weg.

Wie mache ich in Markdown Text farbig?

Standard-Markdown kennt keine Farben. Manche Renderer erlauben HTML wie <span style="color:red">, GitHub entfernt solche Stile aber; dort helfen nur Hinweisblöcke wie [!WARNING] oder Diff-Blöcke.

Wie füge ich in Markdown ein Bild mit fester Größe ein?

Die Markdown-Syntax kennt keine Größenangabe. Wo HTML erlaubt ist, etwa auf GitHub, hilft <img src="bild.png" width="300">.

Weitere Werkzeuge

Das könnte auch helfen

Alle 358 Werkzeuge