Skip to main content

How to Use the official Mermaid Chart for Confluence App

·4 mins

At Mermaid Chart, we love diagrams.

A simple flowchart, sequence diagram, or other diagrams can help communicate an idea with more speed and efficiency than paragraphs of text.

But we’ll let you in on a simple truth: your diagram is only effective if it’s delivered to your intended audience at the moment they need it.

The most comprehensive and stunningly beautiful diagram isn’t worth anything if the reader doesn’t lay eyes on it. That’s why we’ve worked hard to build various integrationsJetBrains IDEs, Visual Studio Code — to help developers embed their Mermaid Chart visuals directly into their code. No more clicking into new windows, losing your place, or losing track of important diagrams.

It’s also why we’re so excited to unveil our new official Mermaid Chart for Confluence app, which is free to download from the Atlassian marketplace. The app allows users to create and edit diagrams directly within Confluence. You can quickly attach diagrams to your Confluence pages, making it simple to visualize your ideas and share them with your team.

Now Confluence users from every industry — developers and non-devs alike — can spend less time searching for diagrams and more time on the things that matter. New users can create a free Mermaid Chart account to get started and check out the app.

Let us show you how it works:

Step-by-step directions for using the Mermaid Chart for Confluence app #

It doesn’t matter if you’re a data enthusiast, software engineer, or visual storyteller; our Confluence app can allow you to embed Mermaid Chart diagrams — and dynamically edit them — within your Confluence pages.

Using the app is easy. Follow these four simple steps:

1. Call up the Mermaid Chart app. #

The Mermaid Chart macro will be available in Confluence once you (or your admin) have installed it from the Atlassian marketplace.

Bring up the Confluence page you want to drop a diagram into. You have two options to start using the app.

  1. Click the plus sign in the Confluence toolbar and search for the Mermaid Chart macro:


  1. Type /mermaidchart anywhere within your Confluence page:


Now it’s time to select your diagram. The app requires you to login into your Mermaid Chart account when using it for the first time.

2. Add a diagram to your Confluence page. #

Once you’ve opened the macro, you’ll see a Mermaid Chart menu.


The default set of diagrams is from your Personal projects within your Mermaid Chart’s account. You can select different folders using the dropdown menu — or even create a new diagram from scratch within this window.

Click the “Select” button on your desired diagram.

3. Optimize your diagram for your Confluence page. #

Before your diagram appears on your Confluence page, you’ll reach a menu that allows you to set a caption and diagram size.


Choose between five sizes: xsmall, small, medium, large, extra large. You may also add a descriptive caption to help guide your readers. Once it’s to your liking, hit the “Insert” button in the bottom right to drop the diagram in.

You can remove a diagram by clicking on the trash can icon as you hover over the visual in Confluence.

4. Edit your diagram with the Mermaid Chart editor. #


Perhaps the coolest part about our app is that you can tweak your Mermaid Chart diagrams without ever leaving the comfort of your Confluence page.

Hover over your inserted diagram and click the edit icon (it’s in the shape of a pencil). This will bring up a Mermaid Chart editor window right in your Confluence page.


Make edits as you normally would using our simple code editor or Visual Editor. Click the “Continue” button to end your Mermaid Chart editing session and jump back into the confluence macro view, where you’ll see a preview of your updated diagram. Now you can adjust the diagram size and caption, and hit the “Save” button in the bottom right.

Get started for free in Mermaid Chart #

The Mermaid Chart for Confluence app is designed to speed up your workflows and save you more time for more important tasks. It also allows you to more clearly express your information to your intended audience of colleagues, managers, or clients.

If you’re tired of clicking into new windows and losing your progress, you’ve got to check it out. Download the app to start reaping the benefits.

And if you’re looking for more Mermaid Chart possibilities, check out our plugins page to learn more about how our platform works with other top software tools.

If you’re new to Mermaid Chart, you can sign up for free to test out our diagramming platform. We’re excited to see what you create!