Zenthas

Mermaid Export Ready: Docs

Add a diagram, build it from Jira, and get it into your PDF export.

Add a diagram

In the Confluence editor, type /Mermaid and insert the macro. The editor opens with a live preview. Pick one of ten starter templates or paste your own Mermaid source. Syntax errors show the line number and the source line, and the last good diagram stays visible.

Load a source file

Attach a .mmd, .mermaid or .md file (with a mermaid block) to the page and choose it as the source.

Build a diagram from Jira

Choose the source Jira, then pick an epic or enter a JQL query. The macro draws up to 150 issues as nodes, colored by status category, with parent and link edges. Jira data is read with the permissions of the person viewing the page. The first time, Confluence asks to allow Jira access. Without it, the rest of the macro still works.

Freeze as text copies issue keys, titles and statuses into the macro as a fixed copy. Everyone who can view the page then sees that text, including people without Jira access.

Light and dark mode, look and layout

Diagrams follow the Confluence color mode without a reload. The default is Mermaid 12.2 with the ELK layout and the neo look. The classic look and the dagre layout can be chosen per diagram for diagrams copied from older tutorials. Exports always use a light print theme.

View, zoom and download

Use the toolbar to fit the diagram to the width, zoom, pan, open it full screen, or download it as SVG or PNG. Ctrl and mouse wheel also zoom. An optional maximum height adds an expand button.

PDF export

Saving a page stores a PNG snapshot as a page attachment named mermaid-<hash>.png. The PDF export uses it. If no snapshot exists yet, the export shows the Mermaid source as a code block with a hint. A page that was never opened after installation has no snapshot until it is opened once.

Search

Titles, descriptions and diagram words are indexed, so a Confluence text search finds the page. Switch this off per diagram in the macro settings.

Limits

Confluence Cloud only. Loading a source from a URL is not available. Old snapshot attachments are not removed automatically; a page editor can delete them from the page attachments.

Need help

See Support. The Mermaid syntax is documented at mermaid.js.org.