# 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.

::: cards
- [Einführung](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/introduction.md)
- [Installation](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/installation.md)
- [Schnellstart](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/quick-start.md)
- [Projektstruktur](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/project-structure.md)
:::

## Deine ersten fünf Minuten

::: steps
1. **Installiere Clay** in deinem Projekt:

   ```bash
   npm install --save-dev clay-doc
   ```

2. **Benenne die Seite** in der `clay.yaml`:

   ```yaml [clay.yaml]
   title: "Mein Projekt"
   ```

3. **Schreib eine Seite**, `docs/index.md`:

   ```markdown [docs/index.md]
   # Willkommen

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

4. **Schau live zu** mit `npx clay dev`, unter [http://localhost:3000](http://localhost:3000).

5. **Bau sie** mit `npx clay build`. Die Seite liegt in `publish/public`, bereit zum Hochladen.
:::

Der [Schnellstart](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/quick-start.md) geht dieselben Schritte ausführlicher durch, mit einem eigenen Bereich und einem Blick aufs Ergebnis.

## Was du brauchst

| | |
|---|---|
| **Node.js** | 20.19 oder neuer, das npm mitbringt, siehe [Installation](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/installation.md) |
| **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](https://clay-doc.github.io/clay-example-repo/4.x/de/publishing/github-pages.md) ist kostenlos und in Minuten eingerichtet |

## Fragen vor dem Start

::: details 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.
:::

::: details 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](https://clay-doc.github.io/clay-example-repo/4.x/de/publishing/build-checks.md) melden.
:::

::: details 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](https://clay-doc.github.io/clay-example-repo/4.x/de/getting-started/installation.md#ohne-installation).
:::

::: details 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.
:::

> [!TIP]
> Du hast schon eine Clay-Seite? Siehe [Umstieg auf Clay 4](https://clay-doc.github.io/clay-example-repo/4.x/de/guides/upgrading-to-clay-4.md).

---

All pages of these docs, as Markdown for language models: https://clay-doc.github.io/clay-example-repo/4.x/de/llms.txt