Clay-Dokumentation

Mach aus einem Ordner voller Markdown-Dateien eine schnelle, durchsuchbare Dokumentationsseite. Alles, was du zum Schreiben, Ordnen und Veröffentlichen mit Clay brauchst.

Auf dieser Seite

Clay macht aus einem Ordner voller Markdown-Dateien eine Dokumentationsseite: eine Seitenleiste aus deinen Ordnern, Volltextsuche, Syntaxhervorhebung, Komponenten wie Tabs und Diagramme, helles und dunkles Design, Versionen und Übersetzungen. Du schreibst die Seiten; um den Rest kümmert sich Clay.

#In einer Minute starten

npm install --save-dev clay-doc
echo 'title: "Mein Projekt"' > clay.yaml
mkdir docs && echo '# Hallo, Clay' > docs/index.md
npx clay dev

pnpm add --save-dev clay-doc
echo 'title: "Mein Projekt"' > clay.yaml
mkdir docs && echo '# Hallo, Clay' > docs/index.md
pnpm exec clay dev

yarn add --dev clay-doc
echo 'title: "Mein Projekt"' > clay.yaml
mkdir docs && echo '# Hallo, Clay' > docs/index.md
yarn clay dev

Öffne http://localhost:3000; jede Änderung, die du speicherst, erscheint sofort. Der Schnellstart führt von dort aus weiter.

#Bereit für KI Neu in Clay 4

Deine Dokumentation, für Menschen und für die Assistenten, die sie fragen. Jede Seite wird auch als Markdown veröffentlicht, llms.txt listet alle für Sprachmodelle, und Leser kopieren eine Seite oder öffnen sie mit einem Klick in ChatGPT oder Claude. Coding-Agenten ändern und prüfen die Dokumentation mit clay edit und clay check.

Jede Seite als MarkdownProbier es aus: Auch diese Seite gibt es als index.md.llms.txtDer Index, nach dem Sprachmodelle suchen, bei jedem Build geschrieben.Für Coding-AgentenEine Änderung pro Befehl, Ergebnisse als JSON und eine Hilfe für Agenten.

Vorgeschlagener Prompt

Lies https://clay-doc.github.io/clay-example-repo/de/llms.txt und richte dann
eine Clay-Dokumentation für dieses Repository ein: eine clay.yaml mit dem Namen
des Projekts, einen Ordner docs/ mit einer Startseite und einen Workflow für
GitHub Pages. Führe `npx clay check` aus, bis es durchläuft.

#Die Dokumentation

Erste SchritteWas Clay ist, wie du es installierst und in fünf Minuten eine erste Seite baust.SchreibenAlles rund um den Inhalt einer Seite, von Markdown und Codeblöcken bis zu Komponenten, Links und Bildern.OrdnenWie aus Seiten und Ordnern die Navigation wird, wie Ordner ihre Seiten bekommen und wie Versionen und Sprachen funktionieren.FunktionenWas jede Clay-Seite mitbringt - Dokumentation für KI-Assistenten und Agenten, Suche, Seitendetails, Designs und Icons sowie Suchmaschinenoptimierung.KonfigurationReferenz der clay.yaml, des Front Matters von Seiten und Ordnern und der Umgebungsvariablen.VeröffentlichenDie clay-Befehle, die Prüfungen jedes Builds und wie die Seite auf GitHub Pages oder bei einem anderen Hoster online geht.AnleitungenUmstieg von älteren Clay-Versionen und Lösungen für häufige Probleme.

#Warum Clay

Markdown rein, Website raus. Seiten sind Markdown-Dateien in docs/, Ordner werden zur Navigation. Keine Templates, kein Theme zum Bauen.
Bereit für KI. Jede Seite als Markdown, llms.txt und Befehle, die Coding-Agenten verstehen, siehe KI & Agenten.
Mehr als Markdown. Tabs, Schritte, Karten, Diagramme, Formeln und Dateibäume, geschrieben als schlichter Text.
Suche inklusive. Jede Seite und jeder Abschnitt ist durchsuchbar, auch mit Tippfehlern, mit Strg + K oder ⌘ + K.
Überall schnell. Jede Seite wird vorab als HTML gerendert. Veröffentliche sie auf GitHub Pages, Netlify oder jedem Webserver.
Bei jedem Build geprüft. Kaputte Links und unbekannte Einstellungen werden gemeldet, und --strict stoppt ein Deployment, das welche hat.
Versionen und Sprachen. Halte die Dokumentation älterer Releases online und übersetze Seite für Seite.
Ordnen im Terminal. clay edit legt Seiten an, ordnet, benennt und übersetzt sie, ohne dass du Front Matter von Hand anfasst.

Tipp

Diese Website ist eine Clay-Seite. Jede Seite ist eine Markdown-Datei im Beispiel-Repository: Sieh dir an, wie sie gemacht ist, oder kopier sie als Ausgangspunkt. Du nutzt schon Clay 3? Siehe Umstieg auf Clay 4.