Auf dieser Seite

Umstieg auf Clay 4 Aktuell

Clay 4 ändert drei Dinge: Das Front-Matter-Feld cards heißt jetzt list, Dateien und Ordner, deren Name mit _ beginnt, sind keine Seiten mehr: Sie enthalten Snippets, und ältere Versionen ziehen von docs-archive/ nach docs/. Alles andere, deine Seiten, Ordner, Links, Übersetzungen und die clay.yaml, bleibt, wie es ist. Bis du es umbenannt hast, meldet clay build jede Datei, die noch cards nutzt, mit einer Warnung, und --strict scheitert.

#Auf einen Blick

Clay 3	Clay 4
`cards: true` in einer `index.md`	`list: true`
`docs/_entwuerfe/idee.md` ist eine Seite	Dateien und Ordner mit `_` am Anfang sind keine Seiten
`docs/` und `docs-archive/1.x/`	`docs/latest/` und `docs/1.x/`, verschoben von `npx clay version`

Den Umstieg kann ein Coding-Agent übernehmen:

Vorgeschlagener Prompt

Stell die Clay-Dokumentation dieses Repositorys auf Clay 4 um, nach
https://clay-doc.github.io/clay-example-repo/de/guides/upgrading-to-clay-4.md.
Der Umstieg ist fertig, wenn `npx clay build --strict` durchläuft.

#Schritte

Aktualisiere Clay.

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

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

yarn add --dev clay-doc@4

Benenne cards in list um. Schreib in jeder index.md mit cards: true stattdessen list: true:
docs/guides/index.md
```
---
title: Anleitungen
cards: true
---
```
docs/guides/index.md
```
---
title: Anleitungen
list: true
---
```
Durchsuche deine Dokumentation danach, oder lass dir die Dateien vom Build auflisten:
```
grep -rl "^cards:" docs docs-archive
```
Benenne Seiten um, die mit _ beginnen, falls es welche gibt, und die Links darauf. Finde sie mit:
```
find docs docs-archive -name "_*"
```
Verschiebe ältere Versionen, falls du docs-archive/ hast:
```
npx clay version
```
Das verschiebt docs/ nach docs/latest/ und jedes docs-archive/<name>/ nach docs/<name>/, damit alle Versionen gleich tief liegen, und gibt Pfaden, die aus docs/ hinausführen, ein ../ mehr. Es zeigt jede Änderung und fragt vorher; siehe die erste Version. Committe das Verschieben für sich.
Prüfe.
```
npx clay build --strict
```
Läuft der Build durch, ist der Umstieg geschafft.

#Was sonst neu ist

KI & AgentenJede Clay-Seite ist bereit für Sprachmodelle - jede Seite als Markdown, ein Index in llms.txt - und mit clay edit und clay check ändern und prüfen KI-Agenten die Dokumentation.KomponentenTabs, Schritte, Karten, einklappbare Abschnitte, Prompts, Badges, Formeln, Diagramme und Dateibäume, geschrieben in schlichtem Markdown.Build-PrüfungenAuch Links auf Abschnitte werden geprüft, und eine Seite, die nicht gerendert werden kann, sagt, warum.Snippets & VariablenEinen Text einmal schreiben und auf vielen Seiten nutzen, Code aus dem Projekt einbinden und Werte wie die aktuelle Version einsetzen.SucheVolltextsuche über jede Seite und jeden Abschnitt, mit Tippfehlertoleranz, markierten Treffern und Tastenkürzeln.SEOJede Seite bekommt ein Bild für Link-Vorschauen, und Seiten unter einem Pfad die Adresse ihrer Sitemap.

theme in der clay.yaml setzt eigene Farben und Schriften, und analytics zählt Seitenaufrufe ohne Cookies, siehe Designs und Analytics.
Einstellungen können in eigenen Dateien stehen, etwa variables: config/variables.yaml, siehe clay.yaml.
generate in der clay.yaml führt vor jedem Build Werkzeuge aus, die Seiten schreiben, etwa eine API-Referenz aus dem Code, siehe generierte Dokumentation.
head in der clay.yaml fügt jeder Seite Skripte und Meta-Tags hinzu, siehe clay.yaml.
Videos und Einbettungen von YouTube, Vimeo, Figma und mehr, siehe HTML.
Alte Adressen verschobener Seiten funktionieren weiter mit redirects im Front Matter, siehe Weiterleitungen.
Codeblöcke zeigen den Namen ihrer Datei: ```yaml [clay.yaml], siehe Codeblöcke.
Auf schmaleren Bildschirmen klappt das Inhaltsverzeichnis einer Seite über ihr auf.
Ein Link „Zum Inhalt springen“, ein deutlicherer Tastaturfokus und stärkere Kontraste machen die Seite mit der Tastatur besser bedienbar und leichter lesbar.
Die Navigation wirkt ruhiger: Die Markierung in der Seitenleiste wandert mit, neue Brotkrumen gleiten herein und Seiten blenden ein. Ist in den Systemeinstellungen „Bewegung reduzieren“ an, bewegt sich nichts.