Getting Started

Prerequisites

• Confluence Cloud or Jira Cloud instance
• Jira Administrator or Confluence Administrator permissions to install apps from the Atlassian Marketplace

Install the App

Install the app for your Atlassian product from the Marketplace:

• Apportunity: Mermaid Diagrams Macro for Confluence
• Apportunity: Mermaid Diagrams for Jira

The two apps are separate Marketplace listings and must be purchased independently.

To install:

1. Go to Settings → Apps → Find new apps.
2. Search for Apportunity: Mermaid Diagrams.
3. Click Try it free or Buy now and follow the prompts.
4. Once installed, the app is immediately available to all users in your instance — no additional configuration required.

Using the App

In Jira

After installation, the Diagrams panel is automatically enabled on all Jira Work Items. To create a diagram:

1. Open any Jira Work Item.
2. Locate the Diagrams panel in the issue view.
3. Click the panel to open the diagram editor and start writing Mermaid syntax.

In Confluence

After installation, the Mermaid Diagram macro is available on all Confluence pages. To insert a diagram:

1. Open or create a Confluence page in edit mode.
2. Click Insert (+) and search for Mermaid Diagram.
3. Select the macro, write your Mermaid syntax, and publish the page.

Next Steps

• Mermaid Diagram Syntax — Explore all supported diagram types and syntax
• Diagram Theming — Customize diagram colors and appearance
• Known Limitations — Understand constraints before building complex diagrams