Markdown-Spickzettel — Syntax mit Live-Vorschau

Ein bis sechs # gefolgt von einem Leerzeichen. Nutze eine #-Überschrift pro Dokument und überspring keine Ebenen; Screenreader und Inhaltsverzeichnisse verlassen sich auf die Reihenfolge.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Der ältere „Setext“-Stil; nur Ebene 1 und 2. Eine Zeile --- unter einem Absatz macht ihn zur Überschrift, was überrascht, wenn man eine horizontale Linie erwartet: Lass vor --- eine Leerzeile.

Heading 1
=========

Heading 2
---------

Eine Leerzeile trennt Absätze. Ein einzelner Zeilenumbruch innerhalb eines Absatzes wird zu einer Zeile zusammengefügt (außer wo unter Zeilenumbrüche angegeben).

First paragraph, which can wrap
across several source lines.

Second paragraph after a blank line.

Für einen Zeilenumbruch ohne neuen Absatz beende die Zeile mit zwei Leerzeichen oder einem Backslash. GitHub-Kommentare, Obsidian (standardmäßig), Slack und Discord behandeln stattdessen jede neue Zeile als Umbruch.

Two trailing spaces  
make a break.
A trailing backslash\
works too.<br>So does an HTML br.

Sternchen funktionieren innerhalb von Wörtern, Unterstriche nicht (snake_case_names bleiben wörtlich) – deshalb bevorzugen die meisten Styleguides *.

**bold** or __bold__

*italic* or _italic_

***bold italic***

in**side**word works with *, not with _

Beginne jede Zeile mit >. Zitate können jedes andere Markdown enthalten, auch Listen und Code.

> Quoted text.
> Still quoted.
>
> > Nested quote.

-, * oder + funktionieren alle; misch sie nicht in einer Liste (ein anderes Zeichen beginnt eine neue Liste).

- Item
- Item
  - Nested (indent 2 spaces)
- Item

Die erste Zahl legt den Start fest; spätere Zahlen werden ignoriert, „1.“ in jeder Zeile nummeriert sich also selbst neu, wenn du Einträge umsortierst.

1. First
1. Second
1. Third

3. Starts at three
4. Four

Rücke zusätzlichen Inhalt so ein, dass er mit dem ersten Zeichen des Eintragstexts fluchtet (3 Leerzeichen nach „1. “).

1. Install:

   ```sh
   npm install marked
   ```

2. Indent continuation lines
   to the item text.

Markdown innerhalb von Backticks wird nicht interpretiert.

Run `npm test` now.

Use ``double `backticks` `` when the code contains one.

Drei Backticks (oder ~~~) in eigenen Zeilen. Das Wort nach dem Zaun benennt die Sprache für Syntax-Highlighting auf GitHub, GitLab, Obsidian und Discord.

```js
const answer = 42;
console.log(answer);
```

const answer = 42;
console.log(answer);

Die ursprüngliche Syntax. Zäune sind übersichtlicher und erlauben eine Sprache; eingerückter Code ist die einzige Form, die das alte Reddit versteht.

Paragraph.

    four spaces of indent
    make a code block

four spaces of indent
make a code block

Drei oder mehr -, * oder _ in einer eigenen Zeile, mit einer Leerzeile darüber.

Above

---

Below (also *** or ___)

Die Form in spitzen Klammern ist der Autolink von CommonMark. Leerzeichen in einer URL müssen als %20 geschrieben oder die URL in <…> eingeschlossen werden.

[Link text](https://freetoolsforweb.com)

[With a title](https://freetoolsforweb.com "Hover text")

[Relative link](/tools/regex-cheat-sheet)

<https://example.com>

Hält lange URLs aus dem Text heraus. Definitionen können irgendwo im Dokument stehen und werden nicht angezeigt.

Read the [spec][cm] and the [GFM spec].

[cm]: https://spec.commonmark.org/
[GFM spec]: https://github.github.com/gfm/

Auf GitHub und GitLab bekommt jede Überschrift automatisch eine ID: kleingeschrieben, Leerzeichen zu Bindestrichen, Satzzeichen entfernt („## Install & Run“ wird zu #install--run). Obsidian nutzt stattdessen [[#Überschrift]].

[Jump to tables](#md-tables)

Wie ein Link mit ! davor. Der Text in [ ] ist der Alt-Text: Beschreib das Bild für Menschen, die es nicht sehen können. Markdown hat keine Syntax für die Größe; nutz HTML <img width="200">, wo HTML erlaubt ist.

![Site logo](/brand/favicon.svg "Optional title")

[![Clickable image](/brand/favicon.svg)](/tools)

Ein Backslash macht jedes ASCII-Satzzeichen wörtlich: \ ` * _ { } [ ] ( ) # + - . ! |

\*not italic\*  \# not a heading  1\. not a list

Von CommonMark erlaubt. GitHub und GitLab behalten eine sichere Teilmenge (kein script, style oder Event-Handler); Slack, Discord, Reddit und Notion zeigen es als Text.

Press <kbd>Ctrl</kbd> + <kbd>C</kbd>, H<sub>2</sub>O, x<sup>2</sup>.

Ein HTML-Kommentar bleibt im Quelltext, wird aber überall, wo HTML erlaubt ist, nicht angezeigt.

Visible.

<!-- Not rendered: notes for editors -->

Also visible.

Die zweite Zeile ist Pflicht; Doppelpunkte legen die Ausrichtung fest. Die Spalten müssen im Quelltext nicht bündig sein. Escape einen wörtlichen senkrechten Strich als \|. Keine verbundenen oder mehrzeiligen Zellen (auf GitHub <br> in einer Zelle verwenden).

Wo: GFM, GitLab, Obsidian, Reddit; Notion beim Einfügen

| Left | Centre | Right |
| :--- | :----: | ----: |
| a    |   b    |     1 |
| `c`  | **d**  |    22 |

Auf GitHub und GitLab sind die Kästchen in Issues und Pull Requests anklickbar und aktualisieren den Quelltext.

Wo: GFM, GitLab, Obsidian; Notion über das Kürzel []

- [x] Write the draft
- [ ] Review
- [ ] Publish

Überall zwei Tilden; GitHub akzeptiert auch eine. Slack nutzt ~einzelne~ Tilden, Jira -Bindestriche-.

Wo: GFM, GitLab, Obsidian, Discord, Reddit, Notion

~~no longer true~~

GFM macht aus nackten URLs und www.-Adressen Links. In reinem CommonMark bleiben sie Text, außer sie stehen in <…>.

Wo: GFM, GitLab, Obsidian, Slack, Discord, Reddit

Visit https://freetoolsforweb.com or www.example.com.

Die Definition kann überall stehen; Fußnoten werden in der Reihenfolge der Verweise nummeriert und am Ende aufgelistet. Obsidian kennt auch Inline-Fußnoten: ^[so wie hier].

Wo: GFM, GitLab, Obsidian (nicht CommonMark)

Markdown was created in 2004.[^1]

[^1]: By John Gruber, with Aaron Swartz.

Legt den Anker selbst fest. Unterstützt von Pandoc, PHP Markdown Extra, Hugo, Jekyll (kramdown), MkDocs und Docusaurus; GitHub und GitLab ignorieren es, zeigen die geschweiften Klammern an und nutzen stattdessen automatische IDs.

Wo: Pandoc, Hugo, Jekyll, MkDocs, Docusaurus; nicht GitHub oder GitLab

### Install {#setup}

Namen zwischen Doppelpunkten. Ein Doppelpunkt in GitHub, Slack, Discord oder Notion öffnet eine Emoji-Auswahl. Das Emoji selbst einzufügen funktioniert überall.

Wo: GitHub, GitLab, Slack, Discord; nicht Obsidian (ohne Plugin) oder CommonMark

Ship it :rocket: :+1: :tada:

TeX zwischen $-Zeichen inline, $$ für einen abgesetzten Block. GitHub akzeptiert auch $`…`$ und einen ```math-Block; GitLab unterstützt dieselben Formen. Notion nutzt $$…$$ für Inline-Formeln.

Wo: GitHub, GitLab, Obsidian, Notion (eigene Syntax)

Inline: $E = mc^2$

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Ein Codeblock mit der Sprache mermaid wird zum Diagramm: Flussdiagramme, Sequenz-, Klassen-, Zustands-, Gantt- und ER-Diagramme.

Wo: GitHub, GitLab, Obsidian, Notion (Mermaid-Codeblock)

```mermaid
flowchart LR
  A[Write] --> B{Review}
  B -->|ok| C[Publish]
  B -->|changes| A
```

GitHub hat fünf Typen: NOTE, TIP, IMPORTANT, WARNING, CAUTION. GitLab (17.10+) akzeptiert dieselbe Syntax. Obsidian hat viel mehr Typen, eigene Titel (> [!tip] Titel) und Einklappen (> [!faq]-).

Wo: GitHub, GitLab 17.10+, Obsidian; anderswo ein normales Zitat

> [!NOTE]
> Useful information.

> [!WARNING]
> Critical content that needs attention.

HTML, aber breit unterstützt. Lass Leerzeilen um das Markdown darin, sonst wird es nicht geparst.

Wo: GitHub, GitLab, Obsidian, die meisten Static-Site-Generatoren

<details>
<summary>Click to expand</summary>

Hidden **Markdown** content.

</details>

Obsidian und einige Editoren (Typora, iA Writer); GitHub zeigt die Gleichheitszeichen an. Nutz <mark>, wo HTML erlaubt ist.

Wo: Obsidian, Typora; nicht GitHub

This is ==highlighted== text.