Content
Render Mermaid diagrams and LaTeX math formulas in your Tiramisu documentation pages.
Render diagrams and mathematical formulas client-side.
Mermaid Diagrams
Create flowcharts, sequence diagrams, and more with mermaid:
mermaid { graph TD
A[Start] --> B[Process]
B --> C[End] }Preview
graph TD
A[Start] --> B[Process]
B --> C[End]Supported Diagram Types
| Type | Syntax |
|---|---|
| Flowchart | graph TD or graph LR |
| Sequence | sequenceDiagram |
| Class | classDiagram |
| State | stateDiagram-v2 |
| Gantt | gantt |
| Pie | pie |
Info
Mermaid content often contains special characters. Wrap it in triple quotes (
...) to avoid parsing issues. Diagrams render client-side and adapt to dark mode automatically.Math Formulas
Render LaTeX math with math. Formulas are rendered using KaTeX:
math { "E = mc^2" }Preview
Warning
Math formulas containing
= must be quoted, since unquoted = is interpreted as a named parameter separator.