Einführung in die Tiramisu-Auszeichnungssprache, ihre Grundprinzipien und den Unterschied zu Tiramisu Docs.
Tiramisu ist eine Auszeichnungssprache, die auf einem einzigen Konzept aufbaut: Funktionsaufrufen. Alles in Tiramisu ist entweder einfacher Text oder ein Funktionsaufruf, was die Syntax einfach und konsistent macht.
Anders als Markdown oder HTML ist Tiramisu nicht an ein bestimmtes Ausgabeformat gebunden. Der Tiramisu-Parser (@timeleap/tiramisu) liest Quelltext und erzeugt einen AST (Abstract Syntax Tree), der in alles kompiliert werden kann — HTML, Svelte-Komponenten, React, PDF oder jedes andere Format.
Grundprinzipien
- Eine Syntax — alles ist ein Funktionsaufruf. Keine Sonderfälle, keine Kurzschreibweisen, keine Mehrdeutigkeiten.
- Komponierbar — Funktionsaufrufe können beliebig tief in andere Funktionsaufrufe verschachtelt werden.
- Ausgabeunabhängig — der Parser erzeugt einen generischen AST. Was Sie damit machen, entscheidet Ihr Compiler-Front-End.
- Erweiterbar — es gibt keine eingebauten Funktionen in der Sprache selbst. Alle Funktionen werden vom Compiler-Front-End definiert.
Tiramisu vs. Tiramisu Docs
Es ist wichtig, zwischen beiden zu unterscheiden:
| Tiramisu (Sprache) | Tiramisu Docs (Framework) | |
|---|---|---|
| Was | Auszeichnungssprache + Parser | Dokumentationsframework |
| Paket | @timeleap/tiramisu | @tiramisu-docs/kit |
| Funktionen | Keine eingebauten | Definiert h1, bold, codeblock, callout, usw. |
| Ausgabe | Generischer AST | Svelte-Komponenten |
Alle Funktionen, die Sie beim Schreiben von Dokumentation verwenden (h1, bold, codeblock, callout usw.), werden von Tiramisu Docs definiert, nicht von der Tiramisu-Sprache selbst.
Ein einfaches Beispiel
bold { Hello } world!Der Parser wandelt dies in einen AST mit einem FunctionCall-Knoten (Name: bold, Inhalt: Hello) um, gefolgt von einem PureText-Knoten (world!). Was als Nächstes passiert, hängt von Ihrem Compiler-Front-End ab.