# Schreiben

Jede Seite ist eine Markdown-Datei in `docs/`, geschrieben in **Clay Flavored Markdown** (CFM): dem Markdown, das du von GitHub kennst, plus Syntaxhervorhebung, Hinweisen und Komponenten. Clay prüft bei jedem Build deine Links.

::: cards
- [Seiten](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/pages.md)
- [Markdown](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/markdown.md)
- [Codeblöcke](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/code-blocks.md)
- [Hinweise](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/alerts.md)
- [Komponenten](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components.md)
- [Links & Bilder](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/links-and-images.md)
- [HTML](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/html.md)
- [Snippets & Variablen](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/snippets-and-variables.md)
- [Generierte Dokumentation](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/generated-docs.md)
:::

## Eine Seite auf einen Blick

Eine Datei, vom Front Matter bis zu den Komponenten:

::: tabs
== Ergebnis
**Einrichtung** ist der Titel der Seite in der Seitenleiste; ihr Text beginnt so:

> [!TIP]
> Schon installiert? Spring zur [Konfiguration](https://clay-doc.github.io/clay-example-repo/4.x/de/configuration/clay-yaml.md).

::: code-group
```bash [npm]
npm install --save-dev clay-doc
```
```bash [pnpm]
pnpm add --save-dev clay-doc
```
:::
== Markdown
````markdown
---
title: Einrichtung
icon: fa-solid fa-wrench
description: Das Projekt in fünf Minuten installieren und konfigurieren.
---

# Das Projekt einrichten

> [!TIP]
> Schon installiert? Spring zur [Konfiguration](../configuration/clay-yaml.md).

::: code-group
```bash [npm]
npm install --save-dev clay-doc
```
```bash [pnpm]
pnpm add --save-dev clay-doc
```
:::
````
:::

## Was wann passt

| Du willst … | Nimm |
|-------------|------|
| Einen Befehl oder eine Datei zeigen | einen [Codeblock](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/code-blocks.md), mit Dateinamen, markierten Zeilen oder einem Diff |
| Dasselbe für npm, pnpm und yarn zeigen, oder für jedes System | [Tabs oder eine Codegruppe](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/tabs.md) |
| Leser der Reihe nach durch etwas führen | [Schritte](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/steps.md) |
| Auf einen Tipp, eine Warnung oder ein Risiko hinweisen | einen [Hinweis](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/alerts.md) |
| Verbergen, was nur manche Leser brauchen | [Details](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/details.md) |
| Leser zu anderen Seiten führen | [Karten](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/cards.md) oder [Links](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/links-and-images.md) |
| Erklären, wie Teile zusammenpassen | ein [Diagramm](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/diagrams.md) oder einen [Dateibaum](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/file-trees.md) |
| Vorschlagen, was man einen KI-Assistenten oder Agenten fragt | einen [Prompt](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/prompts.md) |
| Etwas als neu oder veraltet markieren | einen [Badge](https://clay-doc.github.io/clay-example-repo/4.x/de/writing/components/badges.md) |

## Das Wichtigste

- **Eine Datei, eine Seite.** Aus `docs/guides/setup.md` wird `/guides/setup`.
- **Links funktionieren wie auf GitHub.** Verlinke die `.md`-Datei; Clay macht daraus die URL der Seite und meldet Links, die ins Leere führen.
- **Dateien neben deinen Seiten werden veröffentlicht.** Bilder und Downloads in `docs/` behalten ihre relativen Pfade.
- **Schlichter Text bleibt schlicht.** Auch Komponenten sind Text, jede Seite liest sich also gut im Editor und auf GitHub.

---

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