Deutsch
Über dieses Handbuch

Dieses Handbuch gehört zum Quartz-Plugin quartz-navigations. Und es ist mit ihm gebaut: das Menü darüber und „Zurück / Weiter“ unter jedem Text kommen von dort.

  • Einstieg — die erste Navigation in fünf Minuten
  • Varianten — alle zehn im Vergleich
  • Rezepte — fertige Kombinationen zum Abschauen
  • Nachschlagen — alle Optionen auf einer Seite

Wie die Einträge dafür aussehen, steht in 8.1.

2.3 – Ausblenden und Auswählen

Ausblenden heißt hier: nicht in der Navigation. Die Seite wird trotzdem gebaut und bleibt über ihre Adresse, Links und die Suche erreichbar. Wer eine Seite gar nicht veröffentlichen will, braucht Quartz’ eigene Mittel — draft, ignorePatterns, explicit-publish.

Was von selbst fehlt

WasOptionVorgabe
die 404-Seite—immer ausgeblendet
der Ordner tags mit den Tag-SeitenhideTagstrue
Seiten, die das Plugin unlisted-pages als unlisted markierthideUnlistedtrue
Entwürfe, draft: truehideDraftstrue

hideDrafts greift nur, wenn Entwürfe überhaupt im Bau landen. Mit Quartz’ Plugin remove-draft sind sie vorher schon weg.

---
title: Impressum
navHide: true
---

In einer index.md blendet navHide: true den ganzen Ordner aus, samt allem darin. Das Feld versteht true, false und die Wörter yes/no.

include und exclude — die Konfiguration entscheidet

Muster auf Slugs, also auf den Pfad, wie er in der Adresse steht — ohne .md, mit Bindestrichen statt Leerzeichen.

options:
  exclude:
    - privat          # der Ordner privat mit allem darin
    - "entwuerfe/**"  # alles unter entwuerfe
    - "*/archiv"      # jede Seite oder jeden Ordner archiv eine Ebene tief
ZeichenBedeutung
*beliebig viele Zeichen innerhalb eines Pfadstücks
**beliebig viele Zeichen über Pfadstücke hinweg
?genau ein Zeichen

Ein Ordnername trifft den ganzen Teilbaum. Geprüft wird nicht nur der Slug selbst, sondern auch jeder Ordner darüber: docs passt auf docs/index, auf docs/setup und auf docs/anleitungen/alpha.

include ist das Gegenstück: Steht dort etwas, bleibt nur, was passt. exclude wird zuerst geprüft und gewinnt.

options:
  include: [docs]   # eine Navigation nur für die Dokumentation

docs/* nimmt den Ordner mit

* passt auf jedes Kind von docs — auch auf index, und über die Ordnerprüfung auf alles darunter. Übrig bleibt nichts, und der leere Ordner fällt weg. Wer nur die Ordnerseite ausblendet (exclude: ["docs/index"]), behält den Ordner dagegen: Er verlinkt dann auf seine erste Seite (3.3).

Leere Ordner

Was nach dem Ausblenden übrig bleibt, wird aufgeräumt:

OptionVorgabeWirkung
hideEmptyFolderstrueOrdner ohne sichtbare Kinder fallen weg
keepIndexOnlyFolderstrue… außer sie haben eine eigene Ordnerseite

Weil folder-page jedem Ordner eine Seite erzeugt, bleibt ein Ordner, dessen Seiten alle ausgeblendet sind, mit den Vorgaben stehen — als Link auf seine Ordnerseite. Wer das nicht will, setzt keepIndexOnlyFolders: false. Die Wurzel fällt nie weg.