Auf dieser Seite

Erste Schritte

Clay macht aus einem Ordner voller Markdown-Dateien eine Dokumentationsseite. Du schreibst Seiten in docs/, beschreibst die Seite in clay.yaml, und Clay erzeugt statische Dateien, die du überall veröffentlichen kannst. Keine Templates, kein Theme zum Einrichten, kein JavaScript zum Schreiben.

EinführungWas Clay ist, was es dir abnimmt und wie eine Clay-Seite entsteht.InstallationClay mit npm, pnpm oder yarn in ein Projekt installieren, oder ganz ohne Installation ausführen.SchnellstartDeine erste Clay-Seite, von einem leeren Ordner bis zum fertigen Build in fünf Minuten.ProjektstrukturDie Dateien eines Clay-Projekts, wofür jede da ist und was ins Git gehört.

#Deine ersten fünf Minuten

Installiere Clay in deinem Projekt:
```
npm install --save-dev clay-doc
```
Benenne die Seite in der clay.yaml:
clay.yaml
```
title: "Mein Projekt"
```

Schreib eine Seite, docs/index.md:

docs/index.md

# Willkommen

Das ist die Dokumentation von **Mein Projekt**.

Schau live zu mit npx clay dev, unter http://localhost:3000.
Bau sie mit npx clay build. Die Seite liegt in publish/public, bereit zum Hochladen.

Der Schnellstart geht dieselben Schritte ausführlicher durch, mit einem eigenen Bereich und einem Blick aufs Ergebnis.

#Was du brauchst


Node.js	22.22.3 oder neuer, das npm mitbringt, siehe Installation
Deine Dokumentation	Markdown-Dateien, oder die Lust, welche zu schreiben. Vorhandene READMEs funktionieren, wie sie sind
Einen Editor	Jeden. `clay dev` zeigt jede Änderung sofort im Browser
Einen Hoster	Später, zum Veröffentlichen: GitHub Pages ist kostenlos und in Minuten eingerichtet

#Fragen vor dem Start

Muss ich Vue, Nuxt oder JavaScript können?

Nein. Clay ist damit gebaut, aber du schreibst nur Markdown und ein paar Zeilen YAML. Es gibt kein Theme einzurichten und keinen Code zu schreiben.

Kann ich meine vorhandenen Markdown-Dateien nutzen?

Ja. Clay liest das Markdown, das du von GitHub kennst, und Links zwischen .md-Dateien funktionieren wie dort. Kopier deine Dateien nach docs/, starte clay dev und behebe, was die Build-Prüfungen melden.

Muss mein Projekt ein JavaScript-Projekt sein?

Nein. Clay läuft mit npx in jedem Repository, ob in Go, Python, Java oder etwas anderem geschrieben, siehe ohne Installation.

Was kostet es?

Nichts. Clay ist Open Source unter der Apache-2.0-Lizenz, und die Seiten, die es baut, laufen auf jedem kostenlosen statischen Hoster.

Tipp

Du hast schon eine Clay-Seite? Siehe Umstieg auf Clay 5.