Tiramisu Docs

Writing

Seiten-Metadaten

Jede Dokumentationsseite beginnt mit einem meta-Block, der Metadaten für die Sidebar, die Suche und SEO definiert.

Syntax

tiramisu 
meta {
  title = My Page,
  description = A brief description,
  order = 2,
  group = Guide,
  icon = book,
  author = Jane Doe
}

Felder

FeldTypBeschreibung
titleStringSeitentitel — wird in der Sidebar und im Browser-Tab angezeigt
descriptionStringKurzbeschreibung für SEO-Meta-Tags
orderNumberSortierposition in der Sidebar (niedrigere Werte erscheinen zuerst)
groupStringName der Sidebar-Gruppe (nur für Dateien auf der obersten Ebene)
lastEditedDate stringÜberschreibt das Datum der letzten Bearbeitung (ansonsten wird Git oder die Datei-Änderungszeit verwendet)
iconStringSymbolname (Lucide-Symbol oder vollständige Iconify-ID wie mdi:home)
imageStringOG-Bildpfad (relativ zum Site-Root) oder absolute URL
authorStringAutorenname — wird unter der Seite angezeigt und in JSON-LD eingebunden

Titel

Das Feld title ist das wichtigste — es bestimmt, was in der Sidebar-Navigation angezeigt wird. Wenn es weggelassen wird, wird stattdessen der Slug der Datei verwendet.

Reihenfolge

Verwenden Sie order, um die Position von Seiten innerhalb ihrer Sidebar-Gruppe zu steuern. Seiten werden aufsteigend nach Reihenfolge sortiert — order = 1 erscheint zuerst, order = 2 als Zweites, und so weiter. Seiten ohne Reihenfolge haben standardmäßig den Wert 999.

Gruppen

Für Dateien auf der obersten Ebene (nicht in einem Ordner) bestimmt das Feld group, zu welcher Sidebar-Gruppe die Seite gehört:

tiramisu 
meta { title = Getting Started, group = Guide, order = 1 }

Für Dateien in Ordnern wird die Gruppe automatisch durch den Ordnernamen bestimmt — Sie müssen group nicht setzen.

Ordner-Indexseiten

Eine index.tiramisu-Datei in einem Ordner legt den Anzeigenamen der Gruppe fest:

src/docs
getting-started
index.tiramisu
installation.tiramisu

Wenn index.tiramisu den Wert title = Getting Started hat, wird dies zur Sidebar-Gruppenüberschrift. Ohne diese Angabe wird der Ordnername automatisch in Titelschreibweise umgewandelt — getting-started wird zu "Getting Started".