Auf dieser Seite

Einführung

Clay macht aus einem Ordner voller Markdown-Dateien eine schnelle, durchsuchbare Dokumentationsseite. Du schreibst Seiten in Markdown, beschreibst deine Seite in einer kleinen Konfigurationsdatei, und Clay erzeugt eine statische Seite, die du überall hosten kannst: auf GitHub Pages, Netlify, Cloudflare Pages oder jedem Webserver.

Diese Website ist selbst eine Clay-Seite. Jede Seite, die du hier liest, ist eine Markdown-Datei im Beispiel-Repository, und das Repository dient zugleich als Vorlage zum Abschauen.

#So funktioniert es

Ein Clay-Projekt ist ein Ordner mit einer Konfigurationsdatei und deiner Dokumentation:

mein-projekt
- clay.yamlTitel und Links der Seite
- docsdeine Markdown-Seiten, Bilder und Dateien
  - index.mdoptional: die Startseite

Du arbeitest mit drei Befehlen:

npx clay dev       # Live-Vorschau beim Schreiben
npx clay build     # die statische Seite nach publish/public bauen
npx clay preview   # den Build so prüfen, wie ein Webhoster ihn ausliefert

Clay ist ein einziges npm-Paket, clay-doc. Es baut auf Nuxt und Vue auf, aber du kommst mit keinem davon in Berührung: kein Theme einzurichten, kein Code zu schreiben.

#Was du bekommst

Bereit für KIJede Seite als Markdown, llms.txt und Befehle, die Coding-Agenten verstehen.NavigationEine Seitenleiste aus deinen Ordnern, Brotkrumen und Links zur vorigen und nächsten Seite.SucheJede Seite und jeder Abschnitt, Tippfehler verziehen, nach Bereichen gefiltert.CodeHervorhebung für über 200 Sprachen, markierte Zeilen, Diffs und ein Kopierknopf.KomponentenTabs, Schritte, Karten, Diagramme, Formeln und Dateibäume in schlichtem Markdown.SuchmaschinenTitel, Beschreibungen, kanonische Links, eine Sitemap und strukturierte Daten.Hell und dunkelFolgt dem System der Leser, mit einem Schalter, der sich ihre Wahl merkt.VersionenDie Dokumentation älterer Releases bleibt online, mit Versionswahl.SprachenÜbersetze Seite für Seite; nicht übersetzte Seiten zeigen das Original.

Jede Seite wird vorab als HTML gerendert: Sie lädt schnell, funktioniert ohne JavaScript und passt auf kleine Bildschirme, mit der Navigation in einer Schublade.

#Wie es weitergeht

Installiere Clay, siehe Installation.
Bau eine erste Seite in fünf Minuten mit dem Schnellstart.
Schreib deine Seiten, siehe Schreiben.
Veröffentliche auf GitHub Pages oder bei einem anderen Hoster.

Hinweis

Du kommst von Clay 1 und Clay Oven? Beginne mit dem Umstieg auf Clay 2.