Navigation

Clay baut die Navigation aus deinem docs/-Ordner; ein eigenes Menü musst du nicht pflegen. Füge eine Seite hinzu, und sie erscheint; verschiebe sie in einen Ordner, und sie wandert in der Seitenleiste mit.

#Die Seitenleiste

Die Seitenleiste listet jede Seite und jeden Ordner, der Seiten enthält, verschachtelt wie deine Ordner. Der Titel eines Ordners öffnet seine Seite; der Pfeil daneben blendet die Seiten darin ein und aus. Die Seite, die du liest, ist markiert, und die Ordner um sie herum klappen von selbst auf. Auf kleinen Bildschirmen wandert die Seitenleiste in eine ausklappbare Navigation hinter dem Menü-Button oben links.

#Reihenfolge

In jedem Ordner werden Seiten und Ordner gemeinsam sortiert:

1. Einträge mit order kommen zuerst, von der kleinsten Zahl aufwärts.
2. Alle anderen folgen alphabetisch nach ihrem Datei- oder Ordnernamen.

Seiten bekommen ihr order in ihrem Front Matter, Ordner im Front Matter ihrer index.md:

---
title: Installation
order: 1
---

---
title: Anleitungen
order: 3
---

Dieser Ordner zum Beispiel:

docs/
├── changelog.md          (ohne order)
├── faq.md                (ohne order)
├── guides/               (order: 2 in guides/index.md)
├── installation.md       (order: 1)
└── introduction.md       (order: 0)

erscheint so: Introduction, Installation, Guides, Changelog, FAQ.

Zahlen dürfen negativ sein, und Einträge mit derselben Zahl behalten ihre alphabetische Reihenfolge.

#Brotkrumen

Die Navigationsleiste zeigt, wo die aktuelle Seite liegt: Anleitungen › Fortgeschritten › Tuning. Jeder Teil verlinkt auf die Seite seines Ordners. Tief verschachtelte Seiten zeigen die letzten drei Ebenen. Auf kleinen Bildschirmen sind die Brotkrumen ausgeblendet; dort übernimmt die ausklappbare Navigation.

#Ordnerseiten

Jeder Ordner hat eine eigene Seite unter seinem Pfad: /guides für docs/guides/. Das ist die index.md des Ordners, oder, ohne sie, der Titel des Ordners mit einer Liste der Seiten und Unterordner darin. Brotkrumen und Links auf einen Ordner führen dorthin. Siehe Indexseiten.

#Vor und zurück

Unten auf jeder Seite führen Links zur vorherigen und nächsten Seite. Sie folgen der Reihenfolge der Seitenleiste über Ordnergrenzen hinweg, die Seiten der Ordner eingeschlossen, sodass man die Dokumentation wie ein Buch von vorne bis hinten lesen kann.