Mermaid Macros for Confluence
Setup & Usage Guide
Installation
Install Mermaid Macros for Confluence from the Atlassian Marketplace. The app adds a Mermaid Diagram macro to the Confluence page editor.
No configuration is required. The macro is available immediately after installation.
Working in Jira instead? See Mermaid Diagrams for Jira, the companion app that auto-renders mermaid code blocks in Jira issues.
How It Works
Unlike the Jira app, which auto-detects code blocks, the Confluence app works through a macro. This is because Confluence's editor model is different from Jira's — you insert the macro exactly where you want the diagram, and it renders inline as an interactive SVG at that location.
- In the page editor, type
/Mermaidand select Mermaid Diagram - Paste your Mermaid source into the config dialog
- Click Save — the diagram renders inline at that location
For example, paste the following Mermaid source into the macro:
flowchart LR
A[Start] --> B[Process]
B --> C{Decision}
C -->|Yes| D[Done]
C -->|No| B
Supported Diagram Types
Features
Inline Rendering
Diagrams render directly on the page where you place the macro, so they read as a natural part of your documentation.
Zoom Controls
Fit the diagram to the panel or zoom in and out to inspect fine detail in complex diagrams.
Export & Copy
Copy or download any diagram as SVG or PNG, straight from the macro.
Dark & Light Mode
Theme-aware rendering automatically syncs with your Confluence theme, re-rendering diagrams with the correct color palette when you switch modes.
Per-Diagram Error Handling
If a diagram has a syntax error, the macro surfaces a clear, per-diagram message instead of breaking the page.
Privacy & Security
The app is built for privacy by default. It runs entirely on Atlassian Forge and renders everything in your browser.
- •Zero data-access permissions: the app requests no scopes at all (an empty scope set), so it cannot read, create, or modify any of your content.
- •100% client-side: your diagram source never leaves Confluence — all rendering happens in the browser.
- •No external calls: no external API calls, no analytics, and no tracking.
- •Compliance: inherits SOC 2 Type II and GDPR compliance from the Atlassian Forge platform.
FAQ
My diagram isn't rendering. What should I check?
Make sure the Mermaid source you pasted into the macro is valid. You can validate your diagram using the Mermaid Live Editor before pasting it in.
How is this different from the Jira app?
The Confluence app uses a macro you insert via /Mermaid in the page editor, while Mermaid Diagrams for Jira automatically detects mermaid code blocks in issue descriptions and comments. The difference reflects how each product's editor works.
Does the app modify my Confluence content?
No. The app requests zero data-access permissions (an empty scope set), so it cannot read, create, or modify any page content. The macro only renders the Mermaid source you enter into it.
Is my data sent to external servers?
No. All rendering happens in your browser — your diagram source never leaves Confluence. There are no external API calls, no analytics, and no tracking. See our Security Statement for details.
Support
Need help? Reach out to us: