Ein Dokumentations-Framework basierend auf SvelteKit und der Tiramisu-Auszeichnungssprache.
Tiramisu Docs ist ein Dokumentations-Framework, das auf SvelteKit und der Tiramisu-Auszeichnungssprache aufgebaut ist. Schreiben Sie Ihre Dokumentation in .tiramisu-Dateien — das Framework übernimmt Routing, Navigation, Suche und alles Weitere.
Warning
Beta — Tiramisu Docs befindet sich in aktiver Entwicklung. APIs und Funktionen können sich ändern. Bei Problemen oder wenn Sie beitragen möchten, besuchen Sie das GitHub-Repository.
Kurzüberblick
Erstellen Sie eine Datei, erhalten Sie eine Seite:
meta { title = Getting Started, order = 1, icon = rocket }
Welcome to my docs! Here's how to install:
codeblock { language = bash, "npm install my-library" }
And here's a basic example:
codeblock { language = typescript, "import { create } from 'my-library'
const instance = create({ debug: true })" }Das war's. Keine Konfigurationsdateien, kein Routing-Setup, keine Build-Skripte. Legen Sie eine .tiramisu-Datei in src/docs/ ab und sie wird zu einer Seite.