Zum Inhalt springen
logoClay
Das ist die Dokumentation für Clay 4.x. Zur neuesten Version (5.x)
Auf dieser Seite

Ordnen

Clay baut die Navigation aus deinen Dateien: Jeder Ordner in docs/ ist ein Bereich, jede Markdown-Datei eine Seite. Titel, Icons und Reihenfolge legst du im Front Matter fest, oder du überlässt das clay edit. Auch ältere Releases und andere Sprachen sind Ordner und Dateien.

NavigationWie Clay Seitenleiste, Brotkrumen und Links zur vorigen und nächsten Seite baut, und wie du Seiten ordnest.OrdnerSeiten in Ordnern gruppieren und Ordnern mit index.md Titel, Icon, Reihenfolge und eine eigene Seite geben.IndexseitenDie Startseite und die Seite jedes Ordners sind Markdown-Dateien namens index.md, mit optionaler Liste der Seiten und großem Kopf.VersionenDie Dokumentation älterer Releases online halten, mit Versionswahl und einem Hinweis, der zur neuesten Dokumentation führt.ÜbersetzungenDie Dokumentation Seite für Seite übersetzen, mit Sprachwahl, Ersatz für nicht übersetzte Seiten und einer Oberfläche in zwölf Sprachen.Bearbeiten mit clay editSeiten und Ordner anlegen, bearbeiten, ordnen, umbenennen, verschieben und löschen, übersetzen und die Einstellungen bearbeiten, für jede Version und Sprache.WeiterleitungenAlte Adressen funktionieren weiter, wenn eine Seite umzieht oder einen neuen Namen bekommt, für Lesezeichen, Suchmaschinen und Links von anderen Seiten.

#Von Dateien zur Navigation

  • docs
    • index.mddie Startseite
    • introduction.mdorder: 1
    • guides
      • index.mdtitle: Anleitungen, order: 2
      • setup.md
      • deploying.md
    • reference
      • api.md

#Ein Projekt, viele Ausgaben

Versionen und Sprachen vervielfachen denselben Aufbau. Jede Ausgabe bekommt eigene Adresse, Navigation und Suche:

  • mein-projekt
    • docs
      • latestneueste, Englisch: /
        • setup.md
        • setup.de.mdneueste, Deutsch: /de/setup
      • 1.xVersion 1.x: /1.x
        • setup.md

Leser wechseln Version und Sprache in der Navigationsleiste und bleiben auf der Seite, die sie lesen.

#Das Wichtigste

  • Der Dateibaum ist die Navigation. Verschiebst du eine Datei, wandert sie in der Seitenleiste mit.
  • order bringt Einträge in Reihenfolge. Einträge ohne folgen alphabetisch.
  • Die index.md eines Ordners beschreibt den Ordner. Ihr Front Matter benennt ihn; ihr Text, falls vorhanden, ist die Seite des Ordners.
  • Die neueste Version ist docs/, oder docs/latest/, sobald es Versionen gibt. Ältere sind Kopien daneben, etwa docs/1.x/.
  • Übersetze so viel du magst. Seiten ohne Übersetzung zeigen das Original, mit einem Hinweis.

Tipp

npx clay edit erledigt all das im Terminal: Seiten anlegen, ordnen, umbenennen, verschieben und übersetzen, ohne Front Matter von Hand zu schreiben. Siehe clay edit.

Tippen, um alle Seiten zu durchsuchen.