Symbole

Symbole hinzufügen

Tiramisu Docs verwendet Iconify für Symbole und bietet Zugriff auf über 275.000 Symbole aus mehr als 150 Icon-Sets. Symbole werden bei Bedarf geladen — kein Build-Time-Bundling erforderlich.

Symbol-Format

Symbole verwenden das prefix:name-Format von Iconify:

Sektions-Symbole

Fügen Sie ein icon-Feld zu Ihrer Sektionskonfiguration in tiramisu.config.ts hinzu:

sections: [
  { label: "Guide", path: "guide", icon: "lucide:book-open" },
  { label: "API", path: "api", icon: "lucide:code" },
]

Sektions-Symbole erscheinen in der oberen Leiste neben dem Sektionsnamen.

Seiten- und Gruppensymbole

Fügen Sie icon zum meta-Block einer beliebigen .tiramisu-Datei hinzu:

meta { title = Getting Started, order = 1, icon = lucide:rocket }

Bei Ordner-Indexseiten (index.tiramisu) wird das Symbol auf die Sidebar-Gruppe oder Untergruppe angewendet. Bei regulären Seiten erscheint das Symbol neben dem Seitentitel in der Seitenleiste und im Seitenkopf.

Seitenkopf

Beim Betrachten einer Dokumentationsseite zeigt der Seitenkopf Folgendes an:

• Den übergeordneten Gruppen- oder Untergruppennamen als kleines Label über dem Titel
• Das Seitensymbol (falls gesetzt) neben dem Titel
• Den Seitentitel und die Beschreibung aus meta

Symbole durchsuchen

Verwenden Sie den Iconify Icon Sets-Browser, um Symbole zu finden. Einige beliebte Sets:

Code-Block-Symbole

Code-Blöcke und Code-Blöcke mit Tabs erkennen automatisch Sprachsymbole mithilfe des devicon-plain-Sets. Sie können das automatisch erkannte Symbol überschreiben:

codeblock { language = typescript, icon = "lucide:file-code", """const x = 1""" }