Erfahren Sie, wie Dokumentationsseiten aufgebaut sind und wie dateibasiertes Routing funktioniert.
Dokumentationsseiten sind .tiramisu-Dateien im Verzeichnis src/docs/. Jede Datei wird zu einer Seite auf Ihrer Website.
Dateispeicherort
Platzieren Sie Ihre Dateien in src/docs/ (oder in einem Gebietsschema-Unterordner wie src/docs/, wenn Sie i18n verwenden). Der Dateipfad bestimmt die URL:
| Dateipfad | URL |
|---|---|
src/docs/index.tiramisu | /docs |
src/docs/guide.tiramisu | /docs/guide |
src/docs/api/auth.tiramisu | /docs/api/auth |
Ordnerstruktur
Ordner erstellen automatisch Sidebar-Gruppen. Ein Ordner mit einer index.tiramisu-Datei verwendet den Titel der Indexseite als Gruppenbezeichnung:
src/docs
index.tiramisu
getting-started
index.tiramisu
installation.tiramisu
quick-start.tiramisu
api
index.tiramisu
endpoints.tiramisu
Seitenaufbau
Jede Seite besteht aus zwei Teilen: einem meta-Block und dem Inhalt.
meta { title = Meine Seite, order = 2, group = Leitfaden }
Absatztext kommt hierhin. Verwenden Sie bold { fett } und italic { kursiv } zur Hervorhebung.
h2 { Ein Abschnitt }
Weiterer Inhalt mit code { Inline-Code } und anderer Formatierung.Info
Der
meta-Block muss ganz am Anfang der Datei stehen. Alles danach wird als Seiteninhalt gerendert.Warning
Fügen Sie Ihrer Seite kein
h1 {} hinzu — der title aus dem meta-Block wird automatisch als Seitenüberschrift gerendert. Ein manuelles h1 würde ein Duplikat erzeugen.