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

Ordner

Ordner in docs/ werden zu Abschnitten der Navigation, so tief verschachtelt wie deine Ordner. Ein Ordner erscheint nur, wenn er mindestens eine Seite enthält.

#Name, Icon und Reihenfolge

Ein Ordner beschreibt sich selbst in einer index.md darin, mit demselben Front Matter wie eine Seite:

docs/guides/
├── index.md       # Name, Icon und Reihenfolge des Ordners
├── setup.md
└── deploying.md
---
title: Anleitungen
icon: fa-solid fa-book-open
order: 3
---
Feld Standard Zweck
title die erste Überschrift der index.md, dann der Ordnername Name in Seitenleiste, Brotkrumen und Suche
icon fa-solid fa-folder Font-Awesome-Icon
order keiner Position zwischen den Seiten und Ordnern daneben

Ohne index.md heißt ein Ordner wie sein Ordnername: getting-started wird zu „Getting started“.

#Eine Seite für den Ordner

Hat die index.md unter ihrem Front Matter Text, ist dieser Text die Seite des Ordners. Sie erscheint, wenn Leser den Ordner unter seiner URL öffnen (/guides). Eine index.md nur mit Front Matter benennt den Ordner bloß; seine Seite listet dann die Seiten darin. Siehe Indexseiten.

#Ordner in anderen Sprachen

Übersetze einen Ordner wie eine Seite: Eine index.de.md neben der index.md gibt dem Ordner seinen deutschen Namen und seine deutsche Seite.

---
title: Anleitungen
---

# Anleitungen

Schritt-für-Schritt-Anleitungen für …

Die Reihenfolge kommt immer aus der originalen index.md.

Tipp

clay edit legt Ordner mit ihrer index.md an und schreibt Titel, Icon und Reihenfolge bestehender Ordner. Siehe clay edit.