Clay-Dokumentation

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

#In einer Minute starten

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

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

#Warum Clay

• Markdown rein, Website raus. Seiten sind Markdown-Dateien in docs/, Ordner werden zur Navigation. Keine Templates, kein Theme zum Bauen.
• 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.

#Finde deinen Weg