# Markdown

Clay liest **Clay Flavored Markdown** (CFM): [GitHub Flavored Markdown](https://github.github.com/gfm/), das Markdown aus READMEs und Issues auf GitHub, plus [Hinweise](https://clay-doc.github.io/clay-example-repo/de/writing/alerts.md), [Komponenten](https://clay-doc.github.io/clay-example-repo/de/writing/components.md), [Formeln](https://clay-doc.github.io/clay-example-repo/de/writing/components/math.md) und [Diagramme](https://clay-doc.github.io/clay-example-repo/de/writing/components/diagrams.md). Alles, was GitHub zeigt, funktioniert auch in Clay, und was Clay ergänzt, bleibt auf GitHub lesbar. Jedes Element unten zeigt sein Ergebnis und seinen Quelltext; wähl einmal **Markdown**, um überall den Quelltext zu sehen.

## Überschriften

```markdown
## Ein Abschnitt
### Ein Unterabschnitt
```

`#` ist die Überschrift der Seite; nutze sie einmal pro Seite. `##`- und `###`-Überschriften erscheinen im Inhaltsverzeichnis und werden zu eigenen Suchergebnissen. Jede Überschrift bekommt einen Anker, gebildet wie auf GitHub, damit du auf einen Abschnitt verlinken kannst: Die Überschrift „Zeilenumbrüche“ unten erreichst du als [`#zeilenumbrüche`](#zeilenumbrüche). Fährst du über eine Abschnittsüberschrift, erscheint links ein `#`-Link zum Kopieren.

## Hervorhebung

::: tabs
== Ergebnis
**fett**, *kursiv*, ~~durchgestrichen~~ und `Code im Text`
== Markdown
```markdown
**fett**, *kursiv*, ~~durchgestrichen~~ und `Code im Text`
```
:::

## Zeilenumbrüche

Ein Zeilenumbruch im Text ist ein Zeilenumbruch auf der Seite, wie in GitHub-Kommentaren. Trenne Absätze mit einer leeren Zeile.

::: tabs
== Ergebnis
Erste Zeile
zweite Zeile, im selben Absatz

Ein neuer Absatz
== Markdown
```markdown
Erste Zeile
zweite Zeile, im selben Absatz

Ein neuer Absatz
```
:::

> [!TIP]
> Schreib jeden Absatz in eine Zeile und lass deinen Editor umbrechen. Von Hand umbrochene Absätze zeigen ihre Umbrüche auf der Seite.

## Listen

::: tabs
== Ergebnis
- Kaffee
- Tee
  - Grüner Tee
  - Schwarzer Tee

1. Installieren
2. Konfigurieren
3. Bauen
== Markdown
```markdown
- Kaffee
- Tee
  - Grüner Tee
  - Schwarzer Tee

1. Installieren
2. Konfigurieren
3. Bauen
```
:::

Für Anleitungen in einer Reihenfolge zeigen [Schritte](https://clay-doc.github.io/clay-example-repo/de/writing/components/steps.md) eine nummerierte Liste als Anleitung.

## Aufgabenlisten

::: tabs
== Ergebnis
- [x] Dokumentation schreiben
- [x] Seite bauen
- [ ] Veröffentlichen
== Markdown
```markdown
- [x] Dokumentation schreiben
- [x] Seite bauen
- [ ] Veröffentlichen
```
:::

Die Kästchen lassen sich nicht ändern: Sie zeigen, was im Markdown steht, und Leser können sie nicht abhaken.

## Tabellen

Spalten lassen sich mit Doppelpunkten in der Trennzeile links, mittig oder rechts ausrichten:

::: tabs
== Ergebnis
| Befehl  | Port | Zweck      |
|:--------|:----:|-----------:|
| dev     | 3000 | schreiben  |
| preview | 4173 | prüfen     |
== Markdown
```markdown
| Befehl  | Port | Zweck      |
|:--------|:----:|-----------:|
| dev     | 3000 | schreiben  |
| preview | 4173 | prüfen     |
```
:::

## Zitate

::: tabs
== Ergebnis
> Dokumentation ist ein Liebesbrief an dein zukünftiges Ich.
== Markdown
```markdown
> Dokumentation ist ein Liebesbrief an dein zukünftiges Ich.
```
:::

Ein Zitat, das mit `[!NOTE]`, `[!TIP]` oder ähnlichem beginnt, wird zu einem [Hinweis](https://clay-doc.github.io/clay-example-repo/de/writing/alerts.md).

## Waagerechte Linien

Drei Bindestriche in einer eigenen Zeile ziehen eine Linie über die Seite:

```markdown
---
```

---

## Typografie :badge[Neu in Clay 5]{tip}

Clay setzt den Text deiner Seiten, wie es ein Setzer tun würde: Du schreibst ihn auf der Tastatur, und Leser sehen die richtigen Zeichen.

| Du schreibst | Leser sehen |
|--------------|-------------|
| `->` `<-` `<->` `=>` `<=>` | → ← ↔ ⇒ ⇔ |
| `<=` `>=` `!=` | ≤ ≥ ≠ |
| `1--2`, `a -- b`, `a --- b` | 1–2, a – b, a — b |
| `...` | … |
| `(c)` `(r)` `(tm)` `+-` | © ® ™ ± |
| `"Anführungszeichen"`, `'einfache'`, `geht's` | „Anführungszeichen“, ‚einfache‘, geht’s |

Anführungszeichen folgen der Sprache der Seite: Englische Seiten bekommen “quotes”, französische «guillemets». Für andere setze `quotes` in [messages](https://clay-doc.github.io/clay-example-repo/de/configuration/clay-yaml.md), z. B. `quotes: "»«›‹"`: die öffnenden und schließenden doppelten, dann die einfachen.

Nur Text ändert sich. Code, Links, die ihre Adresse zeigen, HTML-Attribute, Mathematik, [Prompts](https://clay-doc.github.io/clay-example-repo/de/writing/components/prompts.md) und die IDs von Überschriften bleiben, wie sie sind, so funktionieren Links zu Abschnitten weiter. Optionen wie `--strict` bleiben auch. Um ein einzelnes Zeichen zu behalten, setz einen Backslash davor: `\->` zeigt `->`.

## Mehr als Markdown

::: cards
- [Links & Bilder](https://clay-doc.github.io/clay-example-repo/de/writing/links-and-images.md)
- [Codeblöcke](https://clay-doc.github.io/clay-example-repo/de/writing/code-blocks.md)
- [Hinweise](https://clay-doc.github.io/clay-example-repo/de/writing/alerts.md)
- [Komponenten](https://clay-doc.github.io/clay-example-repo/de/writing/components.md)
- [HTML](https://clay-doc.github.io/clay-example-repo/de/writing/html.md)
:::

---

All pages of these docs, as Markdown for language models: https://clay-doc.github.io/clay-example-repo/de/llms.txt