Mermaid Charts & Diagrams report

Mermaid Charts & Diagrams report

Mermaid Charts & Diagrams report – User guide

The Mermaid Charts & Diagrams report lets you create flow charts, sequence diagrams, Gantt charts, and many other diagrams using Mermaid syntax – directly inside Report Builder.

You type Mermaid text, see the preview immediately, and save the result as a report.

image-20251127-173213.png

 

Open the Mermaid report

  1. In Jira, open Report Builder.

  2. Click Create report.

  3. From the template list, choose Mermaid Charts & Diagrams.

The screen has:

  • Configure panel on the left.

  • A Live Editor with example Mermaid code on the right.

  • A Preview area below the editor.

Configure the report

Mermaid text definition

In the Configure panel:

  • Mermaid text definition
    This field stores the final Mermaid code used by the report.
    When you save the report, this is the text that will be rendered.

You can paste your Mermaid diagram here directly, or use the Live Editor first (recommended).

Use the Live Editor

On the right side you’ll see:

  • Instructions and links:

    • Official documentation – full Mermaid syntax reference.

    • Sample diagrams – Flow Chart, Sequence Diagram, Class Diagram, State Diagram, Gantt Chart, Pie Chart, ER Diagram, User Journey, Git Graph.

  • A large text area labeled Live Editor.

  • A Preview area below it.

Edit the Mermaid code in the Live Editor.
Example:

graph TD A[Christmas] -->|Get money| B(Go shopping) B --> C{Let me think} C -->|One| D[Laptop] C -->|Two| E[iPhone] C -->|Three| F[Car]