Auf dieser Seite

Umstieg auf Clay 5 Aktuell

Clay 5 bringt Seiten für APIs aus ihren OpenAPI-Dokumenten, und Request-Zellen, um sie auszuprobieren. Für eine bestehende Seite ändert sich wenig: Vier neue Komponentennamen sind vergeben, Clay schreibt jetzt einige Tags in den Head jeder Seite, die du vielleicht selbst eingetragen hast, und es setzt Pfeile, Striche und Anführungszeichen in deinem Text. Deine Seiten, Ordner, Versionen, Übersetzungen und die clay.yaml bleiben, wie sie sind.

#Auf einen Blick

Clay 4	Clay 5
`::: request`, `::: fields`, `::: endpoints` und `::: credentials` sind Text	Sie sind Komponenten
`og:locale`, ein `favicon.ico` und ein `apple-touch-icon` kommen, wenn überhaupt, aus `head` in der `clay.yaml`	Clay schreibt sie, siehe SEO
`->`, `--`, `...` und `"Anführungszeichen"` erscheinen wie getippt	Sie erscheinen als → – … und mit den Anführungszeichen der Sprache der Seite, siehe Typografie

Ein Coding-Agent kann den Umstieg erledigen:

Vorgeschlagener Prompt

Upgrade the Clay docs in this repository to Clay 5, following
https://clay-doc.github.io/clay-example-repo/guides/upgrading-to-clay-5.md.
The upgrade is done when `npx clay build --strict` passes.

#Schritte

Clay aktualisieren.

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

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

yarn add --dev clay-doc@5

Nach den neuen Komponentennamen suchen. Eine Zeile, die mit ::: request, ::: fields, ::: endpoints oder ::: credentials beginnt, war Text und ist jetzt eine Komponente. Außerhalb von Codeblöcken sind solche Zeilen selten; liste sie mit:
```
grep -rnE "^:{3,} *(request|fields|endpoints|credentials)\b" docs
```
Setz die, die Text bleiben sollen, in einen Codeblock, oder schreib \:::.
Head-Tags entfernen, die Clay jetzt schreibt. Clay fügt jeder Seite og:locale, ein favicon.ico und ein aus deinem favicon gezeichnetes apple-touch-icon hinzu. Wenn head in der clay.yaml sie auch einträgt, entferne sie dort, damit sie nicht doppelt in der Seite stehen:
```
grep -nE "og:locale|apple-touch-icon|favicon\.ico" clay.yaml config/*.yaml
```
Prüfen.
```
npx clay build --strict
```
Wenn der Build durchläuft, ist der Umstieg fertig.

#Was noch neu ist

OpenAPISeiten für jede Operation und jedes Schema einer API, unter der Dokumentation in der Navigation, und Request-Zellen, um sie auf der Seite auszuprobieren.SEOIcons für Suchergebnisse und Homescreens, der Name der Website in Suchergebnissen, und die Sprache jeder Seite für Linkvorschauen.

Gespeicherte Versionen behalten ihre APIs: clay version kopiert die OpenAPI-Dokumente in die Version, so bleiben ihre Seiten, wie sie waren. Siehe Versionen.
footer in der clay.yaml setzt Links und eine Textzeile unter jede Seite, siehe clay.yaml.
Die Seitenleiste lässt sich durch Ziehen ihres Rands breiter oder schmaler machen, und lange Titel enden mit „…“.
In der Seitenleiste bleibt die Seite, von der du kommst, nicht mehr markiert, wenn du einem Link im Text folgst.