Mermaid Diagrams 2.8: rebuilt on Atlassian Forge
CloudScript Mermaid Diagrams for Confluence
Version 2.8
Version 2.8 of CloudScript Mermaid Diagrams for Confluence is now live on the Atlassian Marketplace. The app first shipped in November 2018 on Atlassian Connect, and this release replaces that codebase with one built on Atlassian Forge, Atlassian’s own hosting platform for cloud apps. This change means that the diagram is now drawn in the reader’s browser from the source stored in the macro, and the app runs on Atlassian’s infrastructure rather than on a server we operate.
Mermaid 11
The rendering engine moves from Mermaid 10 to Mermaid 11 (11.15.0 in this release), so any diagram type or syntax feature in the current Mermaid specification renders in the macro. In addition, the app supports the ELK layout engine for flowcharts and other node-based diagrams, selected through the diagram’s frontmatter (config: layout: elk), which produces tidier routing on larger diagrams than the default layout. The macro’s configuration panel keeps its three settings: the diagram source, a theme chosen from Default, Forest, Dark and Neutral, and a checkbox that prints the source beneath the rendered diagram.
Existing diagrams keep working
Pages created with the Connect version continue to render. The new macro reads the diagram source stored by the older version, so nothing needs re-entering and no page needs editing. Diagrams are also included in Confluence’s Export to PDF as they appear on the page.
Export to Word and Export to Email
Both are temporarily unavailable while they are reworked for Forge. They are in progress and will return in a later release; until then a page exported to Word will not carry its diagrams, so keep the Connect-era expectation in mind if Word export is part of your workflow. Where an export is required, use Confluence’s Export to PDF.
What has changed for administrators
Because the app now runs on Forge, Confluence administrators will be asked to approve the new version when it replaces the Connect app on their site. The app does not send your diagram source anywhere outside of Atlassian, since rendering happens in the browser. Your data is only stored in the macro on your Confluence page.
Read more in our User guide.