Getting Started
Erstellen Sie Ihre erste Dokumentationsseite und lernen Sie Meta-Blöcke und dateibasiertes Routing kennen.
Sobald Sie ein Projekt eingerichtet haben, erstellen Sie Ihre erste Dokumentationsseite.
Eine Seite erstellen
Erstellen Sie eine Datei unter src/docs/getting-started.tiramisu:
meta { title = Getting Started, order = 1 }
Welcome to my documentation!
h2 { Installation }
codeblock { language = bash, "bun add my-package" }
h2 { Usage }
Import and use the package:
codeblock { language = typescript, "import { something } from 'my-package'" }Meta verstehen
Jede Seite beginnt mit einem meta-Block, der die Seiten-Metadaten definiert:
| Feld | Beschreibung |
|---|---|
title | Seitentitel, der in der Seitenleiste angezeigt wird |
order | Sortierreihenfolge — niedrigere Zahlen erscheinen zuerst |
group | Name der Seitenleistengruppe (für Dateien auf oberster Ebene) |
description | Seitenbeschreibung für SEO |
icon | Icon-Name für die Seitenüberschrift |
image | OG-Bildpfad oder URL |
author | Autorenname, der unter der Seite angezeigt wird |
Entwicklungsserver starten
Starten Sie den Entwicklungsserver:
bun run devÖffnen Sie http://localhost:5173/docs in Ihrem Browser. Ihre Seite erscheint automatisch in der Seitenleiste.
Dateibasiertes Routing
Der Dateipfad bestimmt die URL:
| Datei | URL |
|---|---|
src/docs/index.tiramisu | /docs |
src/docs/guide.tiramisu | /docs/guide |
src/docs/apidpoints.tiramisu | /docs/apidpoints |
Ordner erstellen automatisch Seitenleistengruppen. Eine index.tiramisu innerhalb eines Ordners legt den Titel der Gruppe fest.
Info
Bearbeiten Sie eine beliebige
.tiramisu-Datei und der Browser lädt sofort neu — das Vite-Plugin übernimmt das Hot Module Replacement.