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.1 – Titel und Ordnerseiten

Der Titel einer Seite

Das Plugin nimmt den ersten Wert, den es findet:

  1. navTitle im Frontmatter
  2. title im Frontmatter
  3. der Dateiname ohne .md — 01 Erste Schritte, nicht der Slug 01-erste-schritte
  4. das letzte Stück des Slugs

navTitle ist für die Fälle da, in denen der Seitentitel für eine Navigation zu lang ist:

---
title: Installation unter macOS, Linux und in Containern
navTitle: Installation
---

Der Titel eines Ordners

Ein Ordner ist in der Navigation ein Knoten, dessen Link seine Ordnerseite ist (docs/index). Sein Titel kommt aus:

  1. navTitle in seiner index.md
  2. title in seiner index.md
  3. dem echten Verzeichnisnamen — 02 Anleitungen, nicht 02-anleitungen
  4. dem letzten Stück des Slugs

Gibt es keine index.md, erzeugt Quartz’ Plugin folder-page die Ordnerseite beim Bauen selbst. Der Ordner bleibt dadurch verlinkbar; sein Titel kommt dann aus dem Verzeichnisnamen.

Ordnernotizen zählen als Ordnerseite

Eine Datei, die wie ihr Ordner heißt (docs/docs.md), und eine _index.md kommen bei Quartz bereits als docs/index an. Für das Plugin sind sie dasselbe wie eine index.md.

Seite und Ordner mit gleichem Namen

ueber.md neben einem Ordner ueber/ ergibt zwei Einträge: die Seite ueber und den Ordner ueber/index. Wer einen daraus machen will, verschiebt die Seite als index.md in den Ordner.

Nummern vor dem Namen

Viele Vaults sortieren mit Nummern: 01 Einstieg, 02 Anleitungen. Die Nummer bestimmt die Reihenfolge (2.2) — im Titel will man sie meist nicht sehen.

options:
  stripNumericPrefix: true

Das entfernt eine führende Zahl mit dem Zeichen danach — 01-, 01 , 01_, 01. — aus dem Titel. Die Reihenfolge bleibt, weil sie aus dem Datei- oder Verzeichnisnamen gelesen wird, nicht aus dem Titel.

Es trifft auch Titel aus dem Frontmatter

Entfernt wird die Nummer aus jedem Titel, der so beginnt, nicht nur aus Dateinamen. Aus title: 1.2 – Die erste Navigation wird 2 – Die erste Navigation: 1 ist die Zahl, . das Zeichen danach. Dieses Handbuch schaltet die Option deshalb nicht ein. Ausgenommen ist nur navTitle — was dort steht, bleibt unverändert.