Auf dieser Seite

Installation

Clay ist auf npm als clay-doc veröffentlicht. Es braucht Node.js 20.19 oder neuer:

node --version   # v20.19.0 oder neuer

#Clay zu einem Projekt hinzufügen

Installiere Clay als Entwicklungsabhängigkeit des Projekts, das du dokumentieren willst:

npm install --save-dev clay-doc

pnpm add --save-dev clay-doc

yarn add --dev clay-doc

Damit steht Clay in der package.json, und die Lockfile hält die genaue Version fest: Jeder Build, auf deinem Rechner oder in der CI, nutzt dieselbe Version.

Ergänze Skripte in der package.json, damit sich niemand die Befehle merken muss:

package.json

{
  "scripts": {
    "docs:dev": "clay dev",
    "docs:build": "clay build --strict",
    "docs:preview": "clay preview"
  }
}

Dann startet npm run docs:dev die Live-Vorschau.

Tipp

Clay installiert zwei Befehle, clay und clay-doc. Sie tun dasselbe; nimm den, der sich in deinen Skripten besser liest.

#Ohne Installation

Dokumentation liegt oft in Repositories, die in Go, Python, Java oder anderen Sprachen geschrieben sind, wo eine package.json fehl am Platz wäre. Du brauchst keine: npx führt Clay direkt von npm aus, in jedem Ordner mit einer clay.yaml und einem Ordner docs/.

npx clay-doc dev

Nenne eine Version, damit jeder Build dieselbe nutzt:

npx clay-doc@4 build --strict

Hinweis

Werkzeuge wie Dependabot können eine Version in einem Befehl nicht aktualisieren; das übernimmst du selbst.

#Clay aktualisieren

npm install --save-dev clay-doc@latest

pnpm add --save-dev clay-doc@latest

yarn add --dev clay-doc@latest

Clay folgt der semantischen Versionierung: Minor- und Patch-Releases bringen Funktionen und Fehlerbehebungen, ohne deine Dokumentation zu brechen. Major-Releases kommen mit einer Umstiegsanleitung, etwa Umstieg auf Clay 4. Das Changelog listet jede Änderung.

#Weiter

Bau deine erste Seite mit dem Schnellstart.