
Documentation
Mermaid Diagrams for JiraBrowse
Documentation
Mermaid Diagrams for JiraGetting 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.

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
-
Open any issue. In the column on the right, below Details, expand Mermaid diagrams. The number next to it is how many diagrams the issue has.

-
Choose Add Mermaid diagram from the ••• menu at the top right of the issue, or click + in the Mermaid diagrams section.

-
Write Mermaid on the left and watch the diagram on the right, or click Templates to start from one. On an issue with no diagrams yet, you can also start from the issue itself: Linked issues, Child issues or Timeline, next to Add diagram, open the editor with that diagram drawn.

-
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.

More places to see diagrams
- A panel under the description, for wide diagrams: click the apps button under the issue title and choose Mermaid diagrams.
- The Diagrams tab in Activity, next to Comments and History.
- Mermaid Diagrams in Jira's Apps menu shows how diagrams are used across the site. See Usage and search.
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
- Quick start: a guided first ten minutes
- Features: everything the app can do
- Data and privacy: what the app stores and where
Stuck on something this page does not cover? Ask the developers.