Seitenleiste

Die Seitenleiste wird automatisch aus Ihrer Dateistruktur generiert. Sie können die Reihenfolge und Gruppierung der Einträge über die Konfiguration und Datei-Metadaten steuern.

Gruppenreihenfolge

Verwenden Sie sidebar.groupOrder, um die Reihenfolge zu steuern, in der Gruppen in der Seitenleiste erscheinen:

sidebar: {
  groupOrder: ["Getting Started", "Writing", "Configuration", "Advanced"],
},

Gruppen, die nicht in groupOrder aufgeführt sind, erscheinen nach den aufgeführten, alphabetisch sortiert.

Ordnerbasierte Gruppierung

Ordner in Ihrem Docs-Verzeichnis werden automatisch zu Sidebar-Gruppen. Der Ordnername wird in einen Titel umgewandelt (z.B. wird getting-started zu „Getting Started").

Um das Label einer Gruppe anzupassen, fügen Sie eine index.tiramisu-Datei im Ordner hinzu:

meta {
  title = Mein benutzerdefinierter Gruppenname
}

Der title aus der Index-Datei wird zum Gruppenlabel in der Seitenleiste.

Gruppierung auf Stammebene

Dateien im Stammverzeichnis einer Sektion (nicht in einem Unterordner) können mit dem group-Feld in ihrem Meta-Block gruppiert werden:

meta {
  title = Meine Seite,
  group = Getting Started,
  order = 1
}

Seiten sortieren

Seiten innerhalb einer Gruppe werden nach ihrem order-Wert sortiert (niedrigere Zahlen erscheinen zuerst). Wenn keine Reihenfolge angegeben ist, werden Seiten alphabetisch nach Titel sortiert.

meta {
  title = Installation,
  order = 2
}

Untergruppen

Verschachtelte Ordner erstellen Untergruppen in der Seitenleiste. Diese erscheinen als einklappbare Abschnitte innerhalb ihrer übergeordneten Gruppe:

Die index.tiramisu in writing/ definiert das Label der „Writing"-Gruppe. Die index.tiramisu in content/ definiert das Label der „Content"-Untergruppe.