Auf dieser Seite

Schnellstart

Von einem leeren Ordner zu einer fertigen Dokumentationsseite in etwa fünf Minuten.

Leg das Projekt an.

mkdir meine-docs && cd meine-docs
npm init -y
npm install --save-dev clay-doc

Konfiguriere die Seite. Leg clay.yaml im Projektordner an. Nur der Titel ist Pflicht:
clay.yaml
```
title: "Mein Projekt"
```
Schreib die erste Seite. Leg docs/introduction.md an:
docs/introduction.md
```
---
title: Einführung
icon: fa-solid fa-door-open
---

# Einführung

Willkommen bei **Mein Projekt**. Das ist die erste Seite seiner Dokumentation.
```
Der Teil zwischen den ----Zeilen ist das Front Matter. Es ist optional; ohne es nimmt Clay den Titel aus der ersten Überschrift. Siehe Seiten.
Schau beim Schreiben zu.
```
npx clay dev
```
Öffne http://localhost:3000 und klick auf deine Seite. Ändere die Markdown-Datei und speichere: Der Browser zeigt die Änderung sofort.
Füg einen Bereich hinzu. Seiten in einem Ordner werden zu einem Bereich der Navigation. Leg docs/guides/setup.md an:
docs/guides/setup.md
```
# Einrichtung

Wie du Mein Projekt einrichtest.
```
Die Seitenleiste zeigt jetzt Guides. Für einen anderen Titel, ein Icon und eine eigene Seite des Ordners leg docs/guides/index.md an:
docs/guides/index.md
```
---
title: Anleitungen
icon: fa-solid fa-book
list: true
---

# Anleitungen

Alles, was du zum Benutzen von Mein Projekt brauchst, Schritt für Schritt.
```
Siehe Indexseiten.
Bau die Seite.
```
npx clay build
```
Clay prüft deine Dokumentation, rendert jede Seite und schreibt eine statische Seite nach publish/public. Mit npx clay preview prüfst du sie so, wie ein Webhoster sie ausliefert.

Dein Projekt sieht jetzt so aus:

meine-docs
- clay.yaml
- docs
  - introduction.md
  - guides
    index.md
    setup.md
- node_modules
- package.json
- publishdie gebaute Seite, bereit zum Hochladen

Hinweis

Trag publish/ und node_modules/ in deine .gitignore ein. Die Build-Ausgabe entsteht bei jedem Build neu und gehört nicht ins Repository.

#Von einem anderen Werkzeug

Dokumentation für MkDocs, Docusaurus, VitePress oder ein anderes Werkzeug ist auch Markdown. Ein Coding-Agent kann sie zu Clay umziehen:

Vorgeschlagener Prompt

Lies https://clay-doc.github.io/clay-example-repo/de/llms-full.txt, um zu lernen, wie
Clay funktioniert. Zieh dann die Dokumentation dieses Repositorys zu Clay um:
die Einstellungen in die clay.yaml, die Navigation in Ordner, index.md-Dateien
und `order`, und die eigene Syntax des alten Werkzeugs, etwa Hinweisboxen und
Tabs, in Clay Flavored Markdown. Entferne die Dateien des alten Werkzeugs, sobald
`npx clay build --strict` durchläuft.

#Wie es weitergeht

GitHub PagesEine Clay-Seite auf GitHub Pages veröffentlichen, mit einem Workflow, der die Dokumentation bei jedem Push prüft und veröffentlicht.IndexseitenDie Startseite und die Seite jedes Ordners sind Markdown-Dateien namens index.md, mit optionaler Liste der Seiten und großem Kopf.NavigationWie Clay Seitenleiste, Brotkrumen und Links zur vorigen und nächsten Seite baut, und wie du Seiten ordnest.KomponentenTabs, Schritte, Karten, einklappbare Abschnitte, Prompts, Badges, Formeln, Diagramme und Dateibäume, geschrieben in schlichtem Markdown.