Skip to content

Getting Started with Mermaid Diagram for Confluence

Mermaid Diagram for Confluence adds a macro that turns Mermaid text into diagrams on your pages. You write the diagram as code, see it as you type, and publish it with the page. It runs entirely on Atlassian Forge, so your diagrams never leave Atlassian.

Mermaid Diagram for Confluence

Where to find it

After installation the app appears in three places:

Where What it's for
The page editor → type /mermaid Adds a Mermaid diagram to the page
Confluence settings → Mermaid Diagram settings Colour themes for the whole site, and every page that uses a diagram (admins only)
Apps → Manage apps → Get started A short welcome page with examples and first steps

Your first diagram

  1. Edit a page and type /mermaid, then choose Mermaid Diagram.
  2. The editor opens with a starter flowchart. Change the code on the left and watch the preview on the right.
  3. Give the diagram a title at the top, then click Save diagram (or press ⌘S / Ctrl+S).
  4. Publish the page.

To start from something other than a flowchart, click Templates and pick one of 12.

Permissions and data

  • Anyone who can view a page can see its diagrams. Only people who can edit the page can change them.
  • Diagrams are stored in the app's Forge storage for your site, inside Atlassian. Small diagrams are also saved in the macro itself so the page draws them instantly.
  • Only Confluence admins can create or change colour themes.

Next steps