Drei Schritte, und die Navigation steht.
1. Plugin installieren
npx quartz plugin add github:boxi-os/quartz-navigationsDer Befehl holt das Plugin und trägt es in die quartz.config.yaml ein — und zwar mit allen
Optionen und ihren Vorgabewerten, als Baum in der linken Spalte (position: left,
priority: 10). Das ist bereits eine funktionierende Navigation. Die lange Liste darf man kürzen:
Was nicht dasteht, nimmt das Plugin selbst als Vorgabe an.
In QuartzControl geht dasselbe über den Marktplatz.
2. Eintragen
Ein kurzer Eintrag für eine Menüleiste im Kopf:
plugins:
- source: github:boxi-os/quartz-navigations
enabled: true
options:
variant: bar
depth: 1
mobile: offcanvas
layout:
position: header
priority: 20variantwählt die Form — hier eine waagerechte Leiste (Kapitel 4).depth: 1zeigt nur die erste Ordnerebene (3.2).mobile: offcanvasmacht daraus auf dem Smartphone ein Menü hinter einem Burger-Button (Kapitel 6).layoutsagt Quartz, wo die Navigation steht. Das ist kein Teil des Plugins, sondern Quartz’ eigener Mechanismus für jede Komponente. Fehlt der Block, verschwindet die Navigation nicht: Quartz stellt sie dann an die Vorgabe des Plugins, links mitpriority: 10.
Eine zweite Navigation ist ein zweiter Eintrag mit derselben source. Mehr dazu unter
1.3.
3. Ansehen
npx quartz build --serveDie Leiste steht im Kopf, der Eintrag der aktuellen Seite ist hervorgehoben, und jeder Ordner über ihr trägt die Markierung des aktiven Pfads. Unterhalb der Mobil-Grenze der Site (6.2) verschwindet die Leiste hinter einem Burger-Button.
Wenn nichts erscheint
| Was zu sehen ist | Woran es liegt |
|---|---|
| Gar nichts, auf keiner Seite, keine Meldung | enabled: false. |
| Die Navigation steht links statt am gewünschten Ort | Der layout-Block fehlt oder ist falsch eingerückt; dann gilt die Vorgabe des Plugins. |
| Gar nichts auf einigen Seiten | rootPath ist gesetzt, und die Seite liegt außerhalb — das ist hideOutsideRoot (3.2). Oder scope findet für diese Seite keinen Ordner (3.1). |
Gar nichts, aber rootPath … is not a folder with visible pages | Den Ordner gibt es nicht, oder alles darin ist ausgeblendet (9.2). |
| Eine Seite fehlt in der Navigation | Entwurf, unlisted, navHide oder ein exclude-Muster (2.3). |
| Die Reihenfolge stimmt nicht | 2.2 – Sortieren. |
| Ordner und Seite heißen „index“ oder tragen Nummern | 2.1 – Titel und Ordnerseiten. |