Skip to content
Yamuno

Getting Started with Mermaid Diagrams for Jira

Mermaid Diagrams for Jira draws Mermaid diagrams right on your Jira issues. You can save diagrams on an issue with a live editor, and any Mermaid already pasted into the description or a comment is drawn too. It runs entirely on Atlassian Forge and stores diagrams on the issue itself, so nothing leaves Atlassian.

The Mermaid diagrams section on a Jira issue, with tabs for four diagrams

Where to find it

Where What it's for
The right-hand column of every issue → Mermaid diagrams The issue's diagrams, with a count while collapsed
An issue → ••• → Add Mermaid diagram Opens the editor for a new diagram
Jira settings → Apps → Mermaid diagram themes Colour themes for the whole site (Jira admins only)
Apps → Manage apps → Get started A short welcome page with an example and first steps

Your first diagram

  1. Open any issue and expand Mermaid diagrams on the right.
  2. Click + (Add diagram), or choose Add Mermaid diagram from the issue's ••• menu.
  3. Write Mermaid on the left and watch the diagram on the right, or click Templates to start from one.
  4. Give it a title and click Save diagram (or press ⌘S / Ctrl+S).

Already have Mermaid in a ticket? Put it in a code block and set the language to mermaid, in the description or a comment. It's drawn in the same section, with no extra step.

Permissions

  • Anyone who can view the issue sees its diagrams.
  • Only people who can edit the issue can add, change or delete diagrams. The app checks this before every save, and Jira checks it again.
  • Only Jira admins can create or change colour themes.

Next steps