The Mermaid logo
The Mermaid logo

Mermaid

By GitBook

Build diagrams and visualizations using Markdown-inspired text definitions and code.

You ca use the Mermaid integration to embed diagrams and visualizations in GitBook documentation
You ca use the Mermaid integration to embed diagrams and visualizations in GitBook documentation

Overview

Mermaid lets you create diagrams and visualizations using text and code. If you are familiar with Markdown you should have no problem learning Mermaid's Syntax.

How it works

Once the integration is installed, insert the Mermaid block into any page. You can edit the code content and preview how it looks using the live editor.

When using the GitHub or GitLab integrations, all code blocks with the mermaid syntax will be replaced by diagram. All diagrams inserted from the editor will be formatted as such code blocks in Markdown.

Configure

You can install the integration on the single space by clicking on the Integrations button in the sub-space navigation, or on multiple spaces by navigating to the organization settings.

Get started for free

Play around with GitBook and set up your docs for free. Add your team and pay when you’re ready.

Trusted by leading technical product teams

The NVIDIA logo
The Carta logo
The Ericsson logo
The Cisco logo
The Fedex logo
The Zoom logo
  • The Braze logo
  • The Bucket logo
  • The Cortex logo
  • The Count logo
  • The Digibee logo
  • The Gravitee logo
  • The Hebbia logo
  • The HockeyStack logo
  • The Ideogram logo
  • The JAM logo
  • The Make logo
  • The Material logo
  • The Multiplier logo
  • The Nightfall AI logo
  • The Onum logo
  • The Photoroom logo
  • The Pylon logo
  • The Relay.app logo
  • The Rox logo
  • The ScraperAPI logo
  • The Seam logo
  • The Sendbird logo
  • The Sola logo
  • The Synk logo
  • The Tabnine logo
  • The ZenML logo

Get started for free

Play around with GitBook and set up your docs for free. Add your team and pay when you’re ready.

Trusted by leading technical product teams

The NVIDIA logo
The Carta logo
The Ericsson logo
The Cisco logo
The Fedex logo
The Zoom logo
  • The Braze logo
  • The Bucket logo
  • The Cortex logo
  • The Count logo
  • The Digibee logo
  • The Gravitee logo
  • The Hebbia logo
  • The HockeyStack logo
  • The Ideogram logo
  • The JAM logo
  • The Make logo
  • The Material logo
  • The Multiplier logo
  • The Nightfall AI logo
  • The Onum logo
  • The Photoroom logo
  • The Pylon logo
  • The Relay.app logo
  • The Rox logo
  • The ScraperAPI logo
  • The Seam logo
  • The Sendbird logo
  • The Sola logo
  • The Synk logo
  • The Tabnine logo
  • The ZenML logo

Get started for free

Play around with GitBook and set up your docs for free. Add your team and pay when you’re ready.

Trusted by leading technical product teams

The NVIDIA logo
The Carta logo
The Ericsson logo
The Cisco logo
The Fedex logo
The Zoom logo
  • The Braze logo
  • The Bucket logo
  • The Cortex logo
  • The Count logo
  • The Digibee logo
  • The Gravitee logo
  • The Hebbia logo
  • The HockeyStack logo
  • The Ideogram logo
  • The JAM logo
  • The Make logo
  • The Material logo
  • The Multiplier logo
  • The Nightfall AI logo
  • The Onum logo
  • The Photoroom logo
  • The Pylon logo
  • The Relay.app logo
  • The Rox logo
  • The ScraperAPI logo
  • The Seam logo
  • The Sendbird logo
  • The Sola logo
  • The Synk logo
  • The Tabnine logo
  • The ZenML logo