FAQ
Is Mermaid Charts & Diagrams for Confluence compatible with Confluence Server or Confluence Data Center?
Yes, there is also a Confluence Server version and a Confluence Data Center version of the app available in the Atlassian Marketplace.
Why is a “Getting Mermaid diagram failed” error shown when exporting the page (as PDF)?
If you experience a “Getting Mermaid diagram failed” error saying that “An error occurred while retrieving the Mermaid diagram from the URL […]“ as shown below in your export file, most likely the app does not have permission to get the content from your Confluence page or space.
To fix this, please grant read access for the user “Mermaid for Confluence” for the affected page or the complete space. The following screencast shows how to grant read access for the user “Mermaid for Confluence” for a page which has restricted permissions. If you don’t find the user “Mermaid for Confluence”, just start typing and the autocompleter should show up.
What kind of textual representation is used to describe the charts and diagrams?
As Mermaid Charts & Diagrams for Confluence is based on the MIT licensed library Mermaid (https://mermaid.js.org/), it uses the library’s syntax that is described here https://weweave.net/s/confluence-mermaid/syntax .
How can we track where Mermaid Charts & Diagrams for Confluence is used?
Confluence Cloud
As Confluence Cloud administrator, you can use the built-in “Macro usage” report (under https://[YOUR-CONFLUENCE-INSTANCE/wiki/admin/pluginusage.action) to see which macro is used on which page.
The macros provided by the app “Mermaid Charts & Diagrams for Confluence” are prefixed with “confluence-mermaid-” as shown below:
If you have migrated your Content from a Confluence Server or Data Center to a Confluence Cloud instance with the Confluence Cloud Migration Assistant (CCMA), you should also check the usage count of the macro “mermaiddiagram“.
Data Center & Server
As Confluence administrator, you can use the built-in “Macro usage” report (under https://[YOUR-CONFLUENCE-INSTANCE/admin/pluginusage.action) to see which macro is used on which page.
The app “Mermaid Charts & Diagrams for Confluence” provides only one macro named “mermaiddiagram” which is listed as shown below: