Read in:
English

Mermaid diagrams

A mermaid code block in any note becomes a rendered diagram on the published page. Write diagrams the same way you write them in Obsidian.

How to use it

Add a code block with the language identifier mermaid and paste your diagram syntax inside:

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do it]
    B -->|No| D[Skip it]
    C --> E[Done]
    D --> E
```

That block renders as a diagram for every reader who opens the page. All diagram types that Mermaid supports work — flowcharts, sequence diagrams, pie charts, Gantt charts, class diagrams, state diagrams, and more.


Examples

Flowchart

```mermaid
graph LR
    Write[Write in Obsidian] --> Sync[Press Sync]
    Sync --> Live[Note is live]
    Live --> Readers[Readers see it]
```
graph LR
    Write[Write in Obsidian] --> Sync[Press Sync]
    Sync --> Live[Note is live]
    Live --> Readers[Readers see it]

Sequence diagram

```mermaid
sequenceDiagram
    participant Author
    participant trip2g
    participant Reader

    Author->>trip2g: Sync vault
    trip2g->>trip2g: Build pages
    Reader->>trip2g: Open URL
    trip2g->>Reader: Serve page with diagram
```
sequenceDiagram
    participant Author
    participant trip2g
    participant Reader

    Author->>trip2g: Sync vault
    trip2g->>trip2g: Build pages
    Reader->>trip2g: Open URL
    trip2g->>Reader: Serve page with diagram

Pie chart

```mermaid
pie title Content breakdown
    "Articles" : 45
    "Tutorials" : 30
    "References" : 25
```
pie title Content breakdown
    "Articles" : 45
    "Tutorials" : 30
    "References" : 25

Performance

The Mermaid renderer is a large JavaScript library. trip2g loads it lazily — only on pages that actually contain a mermaid block. Pages without diagrams pay no loading cost at all. This mirrors how datachart loads ECharts.

Rendering happens in the reader's browser.


Supported diagram types

Any diagram type from the Mermaid documentation works:

Type Syntax keyword
Flowchart graph / flowchart
Sequence diagram sequenceDiagram
Pie chart pie
Gantt chart gantt
Class diagram classDiagram
State diagram stateDiagram-v2
Entity relationship erDiagram
User journey journey

The full syntax reference is at mermaid.js.org.