Auf dieser Seite

Projektstruktur

Ein Clay-Projekt hat einen festen Aufbau. Clay sucht seine Dateien im Projektordner: dem Ordner, in dem du clay ausführst, oder dem, den du mit --root angibst.

mein-projekt
- clay.yamlPflicht: Einstellungen der Seite
- logo.svgoptional: Logo und Favicon, genannt in clay.yaml
- docsPflicht: die Seiten der aktuellen Version
  - index.mdoptional: die Startseite
  - introduction.md
  - introduction.de.mdoptional: eine Übersetzung
  - guides
    index.mdoptional: Titel, Icon, Reihenfolge und Seite des Ordners
    setup.md
    img
    screen.pngBilder und Dateien werden veröffentlicht, wie sie sind
- package.jsonoptional: Clay als Entwicklungsabhängigkeit
- publishvon clay build erzeugt; nicht committen

#Wofür jeder Teil da ist

Pfad	Zweck	Mehr dazu
`clay.yaml`	Titel, Basis-URL, Links in der Navigationsleiste, Sprachen	clay.yaml
`docs/`	Jede `.md`-Datei ist eine Seite; andere Dateien werden veröffentlicht, wie sie sind	Seiten
`index.md`	Die Startseite (`docs/index.md`) sowie Titel, Icon, Reihenfolge und Seite eines Ordners	Indexseiten
`*.de.md` und ähnliche	Übersetzungen der Seite daneben	Übersetzungen
`docs/latest/`, `docs/<name>/`	Mit Versionen: die neueste Dokumentation und je eine gespeicherte Kopie älterer Releases	Versionen
`publish/public/`	Die fertige Website	Befehle

#Regeln für den Ordner docs

Jede Markdown-Datei wird eine Seite. Ihr Pfad ist ihre URL: docs/guides/setup.md liegt unter /guides/setup.
Ordner werden Bereiche der Navigation. Ein Ordner erscheint nur, wenn er mindestens eine Seite enthält, in beliebiger Tiefe.
Jede andere Datei, etwa Bilder, PDFs oder Downloads, wird unverändert in die Seite kopiert, damit Seiten auf sie verlinken können.
Namen, die mit einem Punkt beginnen (.DS_Store, .git), werden ignoriert.

#Was ins Git gehört

Committe clay.yaml, docs/, dein Logo sowie package.json mit ihrer Lockfile. Lass die Build-Ausgabe und die Abhängigkeiten weg:

.gitignore

node_modules/
publish/

Tipp

Clay zeigt, wann jede Seite zuletzt geändert wurde, und nimmt das aus Git. Halte die Dokumentation in einem Git-Repository und checke in der CI die ganze Historie aus, um diese Daten zu bekommen. Siehe Seitendetails.