Mermaid diagrams for Miro

With the Mermaid app, you can easily create code-based diagrams inside Miro.

How to install the app

You can install the app from Miro Marketplace or by following this link. You’ll need to select a Miro team to complete the installation.

You can also install the app by simply adding it to the Creation toolbar:

1. In the Creation bar, select Tools, Media and Integrations (+).
   The Tools, Media and Integrations panel opens.
2. In the Tools tab, search and select Mermaid Diagrams.
   
   Adding Mermaid Diagrams through the Creation toolbar
3. The Mermaid Diagrams panel opens.

⚠️ Non-admin users can’t install apps if this is not allowed in team settings.

Creating diagrams and adding them to Miro boards

As you install the app, you'll see it on your Creation toolbar. 

The app has a default sample code. As you change the code to build your diagram, the diagram is refreshed in the preview area on the right. 

Changing a diagram code

The Mermaid app has several sample diagrams available at the bottom left corner - you can choose one of these and then customize it for your needs. 

Change the size of the code editor pane by dragging it from its right edge.

Changing the size of the code editor

To learn more about the syntax Mermaid uses, refer to the official documentation. You can also access the documentation from the bottom left corner of the app panel.

As you finish building your diagram, click Add to board. The diagram will be added to the board as an image. You can download the image or share the board with the diagram with your collaborators.

Adding a diagram to the board

Editing diagrams

You can also edit Mermaid diagrams directly within the Miro board. 

1. Click the diagram to select it
2. Click the Mermaid icon in the Creation toolbar
3. The Mermaid editor will open. Make your changes and click Update Diagram 
4. You will be returned to your Miro board and your diagram will be updated