Versions Compared

Version Old Version 39 New Version Current
Changes made by

weweave UG

weweave UG

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Log into your Confluence instance as an admin.

  2. Click on “Apps > Manage apps” in the header menu.

  3. Click on “Find new apps” on the right navigation.

  4. Search for “Mermaid Charts & Diagrams for Confluence” and select it.

  5. Click on “Try it free” to install the app.

Usage

Macros “Mermaid diagram” and "Mermaid diagram (Remote)"

Mermaid Charts & Diagrams for Confluence provides two macros called “Mermaid diagram” and "Mermaid diagram (Remote)" that can be added to any Confluence page. Both macros can be added by clicking the “Insert” / “+” Button in the edit mode and selecting respective macro.

...

  • Theme: Option to define how the diagram should be rendered (“Default” automatically renders the diagram based on the users' current Confluence theme)

  • Look: Option to define the look of the rendered diagram ("hand drawn" is supported for flowcharts and state diagrams)

  • Allow download: Add a button to download the Mermaid diagram as image (PNG or SVG) or the Mermaid source code

  • Allow fullscreen: Add a button to show the Mermaid diagram in a fullscreen dialog

  • Allow copy to clipboard: Add a button to copy the Mermaid source code to the clipboard

  • Allow pan & zoom: Add buttons to pan and zoom (when viewing the Mermaid diagram)

  • Do not shrink to fit available width: Set Mermaid option “useMaxWidth: false” if available for the diagram type

  • Height: Height in pixel that are used to render the macro (leave blank to use as much height as the diagram needs)

  • Zoom: Optional zoom factor to resize the rendered diagram (between 1 and 100)

  • Export width: Optional width for the Confluence PDF export in percentage (between 1 and 100)

...

The Mermaid code can be added as macro body and the macro is rendered after publishing /updating the page.

...

Mermaid diagram configuration

When rendering the Mermaid code we automatically apply some Mermaid configurations for specific diagram types which are documented below.

Architecture diagram

The Iconify icon pack “logos” is included when rendering architecture diagrams and the icons are available under the prefix “logos” (see https://mermaid.js.org/syntax/architecture.html#icons).

Please note that icons included in icon packs are currently not supported when exporting the diagram (as image or Confluence page).