Schnellstart

Diese Anleitung führt dich in etwa fünf Minuten von einem leeren Ordner zu einer fertigen Dokumentationsseite.

#1. Das Projekt anlegen

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

#2. Die Seite konfigurieren

Lege im Projektordner eine clay.yaml an. Nur der Titel ist Pflicht:

title: "Mein Projekt"

#3. Die erste Seite schreiben

Lege einen Ordner docs/ mit einer Markdown-Datei 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. Alle Felder findest du unter Seiten.

#4. Beim Schreiben ansehen

npx clay dev

Öffne http://localhost:3000. Die Startseite zeigt deine Seite; ein Klick öffnet sie. Ändere die Markdown-Datei und speichere: Der Browser lädt neu und zeigt deine Änderung.

#5. Struktur hinzufügen

Seiten in einem Ordner werden zu einem Abschnitt der Navigation. Lege docs/guides/setup.md an:

# Einrichtung

Wie man Mein Projekt einrichtet.

Die Seitenleiste zeigt jetzt einen Abschnitt Guides. Um dem Ordner einen anderen Namen, ein Icon und eine eigene Einleitung zu geben, lege docs/guides/index.md an:

---
title: Anleitungen
icon: fa-solid fa-book
list: true
---

# Anleitungen

Alles, was du zum Arbeiten mit Mein Projekt brauchst, Schritt für Schritt.

Der Text wird zur Seite des Ordners unter /guides, mit einer Liste seiner Seiten darunter. Genauso wird docs/index.md zur Startseite; siehe Indexseiten.

#6. Die Seite bauen

npx clay build

Clay prüft deine Dokumentation, rendert jede Seite und schreibt eine statische Website nach publish/public. Prüfe sie so, wie ein Webhoster sie ausliefern würde:

npx clay preview

Das war‘s: publish/public ist bereit zum Hochladen. GitHub Pages zeigt, wie du die Seite bei jedem Push automatisch veröffentlichst.

#Wie es weitergeht

• Schreib die Startseite: Indexseiten.
• Bring Seiten und Ordner in eine Reihenfolge: Navigation.
• Sieh dir alle Einstellungen an: clay.yaml.