Use Mermaid diagrams

Who can use this feature?

🔐 Only workspace editors can add and edit Mermaid diagrams.

⭐️ Available on all plans.

Mermaid is a diagramming tool that uses Markdown-inspired text definitions to create and modify diagrams. With Mermaid, you can generate flow charts, UML diagrams, pie charts, Gantt charts, and more, directly in Nuclino.

Tip

You can also create diagrams directly in Nuclino by adding a canvas! Type /canvas to get started.

To add a Mermaid diagram

  1. Open the item you'd like to add a diagram to.

  2. Click on an empty line or create a new one.

  3. Click on the insert button (the red + icon) or type /.

  4. Select Apps & integrations.

    nuclino-insert-menu-apps
  5. Select Mermaid (you can type to search).

    nuclino-insert-menu-mermaid
  6. Paste or type a Mermaid diagram definition.

    nuclino-mermaid-diagram-example
  7. Click on the save button or press Ctrl/Cmd + Enter to save the diagram.

To edit a Mermaid diagram

  1. Click on a diagram to select it or right-click on a diagram and select Edit.

  2. Change the diagram definition.

  3. Click on the save button or press Ctrl/Cmd + Enter to save the diagram.

To maximize or minimize a Mermaid diagram

  1. Right-click on a diagram.

  2. Select Maximize or Minimize.

To comment on a Mermaid diagram

  1. Right-click on a diagram.

  2. Select Comment.

  3. Type and submit a comment.

To delete a Mermaid diagram

Using the context menu

  1. Right-click on a diagram.

  2. Select Delete.

Using the diagram menu

  1. Click on a diagram to select it.

  2. Click on the delete button.

Using the keyboard

  1. Click on a diagram to select it or select it via your keyboard.

  2. Press Backspace or Delete.