Auf dieser Seite
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.
SeitenWie aus Markdown-Dateien Seiten werden, woher Seiten ihre Titel bekommen und welche Front-Matter-Felder Clay liest.MarkdownClay Flavored Markdown - GitHubs Markdown plus Hinweise, Komponenten, Formeln und Diagramme - von Überschriften und Listen bis zu Tabellen und Aufgabenlisten, mit Beispielen.CodeblöckeSyntaxhervorhebung für über 200 Sprachen, Dateinamen, hervorgehobene Zeilen, Diffs, Fokus und ein Kopierknopf.HinweiseSechs Arten von Hinweiskästen für Notizen, Tipps und Warnungen, geschrieben mit der Hinweis-Syntax von GitHub.KomponentenTabs, Schritte, Karten, einklappbare Abschnitte, Prompts, Badges, Formeln, Diagramme und Dateibäume, geschrieben in schlichtem Markdown.Links & BilderZwischen Seiten verlinken wie auf GitHub, auf Abschnitte verlinken, Bilder einfügen und Downloads anbieten.HTMLHTML in Markdown nutzen, Videos und Einbettungen, und was Clay entfernt, um deine Seite sicher zu halten.Snippets & VariablenEinen Text einmal schreiben und auf vielen Seiten nutzen, Code aus dem Projekt einbinden und Werte wie die aktuelle Version einsetzen.Generierte DokumentationAPI-Referenz aus dem Code und andere Seiten, die Werkzeuge schreiben, vor jedem Build erzeugt.
#Eine Seite auf einen Blick
Eine Datei, vom Front Matter bis zu den Komponenten:
Einrichtung ist der Titel der Seite in der Seitenleiste; ihr Text beginnt so:
Tipp
Schon installiert? Spring zur Konfiguration.
---
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, mit Dateinamen, markierten Zeilen oder einem Diff |
| Dasselbe für npm, pnpm und yarn zeigen, oder für jedes System | Tabs oder eine Codegruppe |
| Leser der Reihe nach durch etwas führen | Schritte |
| Auf einen Tipp, eine Warnung oder ein Risiko hinweisen | einen Hinweis |
| Verbergen, was nur manche Leser brauchen | Details |
| Leser zu anderen Seiten führen | Karten oder Links |
| Erklären, wie Teile zusammenpassen | ein Diagramm oder einen Dateibaum |
| Vorschlagen, was man einen KI-Assistenten oder Agenten fragt | einen Prompt |
| Etwas als neu oder veraltet markieren | einen Badge |
#Das Wichtigste
- Eine Datei, eine Seite. Aus
docs/guides/setup.mdwird/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.