Tiramisu Docs

Inhalte

Visuelle Elemente

Zeigen Sie Tabellen, Bilder, Dateibäume und andere strukturierte visuelle Inhalte in Ihrer Dokumentation an.

Komponenten zur Anzeige strukturierter Daten und Medien.

Tabellen

Zeilenbasierte Tabellen

tiramisu
table {
  row = [Name, Type, Default],
  row = [title, String, Documentation],
  row = [theme, Object, Default theme]
}
Preview
NameTypStandard
titleStringDokumentation
themeObjectStandard-Theme

Die erste row wird zur Tabellenüberschrift. Alle nachfolgenden Zeilen sind Inhaltszeilen.

CSV-Tabellen

Sie können Tabellen aus CSV-Daten mit dem Parameter csv rendern. Am einfachsten ist das Laden aus einer Datei mit readfile:

tiramisu
table { csv = readfile { src = sample-data.csv } }
Preview
NameRoleStatus
AliceEngineerActive
BobDesignerActive
CarolManagerOn Leave

Sie können CSV-Daten auch inline übergeben. Die CSV-Verarbeitung unterstützt Felder in Anführungszeichen mit Kommas und escapten Anführungszeichen.

Dies ist nützlich, um Daten vom Dokumentationsinhalt zu trennen oder um Daten zwischen Seiten zu teilen.

Listen

Ungeordnete Listen:

tiramisu
list { First item, Second item, Third item }
Preview
  • Erstes Element
  • Zweites Element
  • Drittes Element

Geordnete Listen:

tiramisu
list { type = ordered, First, Second, Third }
Preview
  1. Erstens
  2. Zweitens
  3. Drittens

Bilder

tiramisu
image { src = /logo.svg, alt = Tiramisu logo }

Bilder unterstützen Klicken zum Vergrößern. Sie können eine optionale Bildunterschrift hinzufügen:

tiramisu
image { src = /logo.svg, alt = Tiramisu logo, caption = The Tiramisu logo }

Die Bildunterschrift erscheint als kleiner Text unter dem Bild.

Preview
Matterhorn-Gletscher, Zermatt, Schweiz

Karten

Navigationskarten zum Verlinken zwischen Seiten:

tiramisu
cards {
  card { title = Getting Started, description = Set up your project, href = /docs },
  card { title = Configuration, description = Customize your site, href = /docs }
}

Karten unterstützen optionale Parameter icon und image:

tiramisu
cards {
  card { title = Quick Start, description = Get up and running, href = /docs, icon = rocket },
  card { title = Gallery, description = Browse examples, href = /docs, image = /preview.png }
}

Icons verwenden Iconify-Symbolnamen (siehe Icons). Bilder werden als Titelbild über dem Karteninhalt angezeigt.

Dateibäume

Verzeichnisstrukturen anzeigen:

tiramisu
filetree {
  folder { src,
    folder { docs,
      file { index.tiramisu },
      file { guide.tiramisu }
    },
    folder { lib,
      file { config.ts }
    }
  }
}
Preview
src
docs
index.tiramisu
guide.tiramisu
lib
config.ts