Integration
Mermaid
Build diagrams and visualizations using Markdown-inspired text definitions and code.
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.
"We can use our documentation for prospects, not just customers. Finding a certain page in Google is just way easier with GitBook."
Roman Musatkin
,
Head of Product & Design
Swarmia
"We can use our documentation for prospects, not just customers. Finding a certain page in Google is just way easier with GitBook."
Roman Musatkin
,
Head of Product & Design
Swarmia
"We can use our documentation for prospects, not just customers. Finding a certain page in Google is just way easier with GitBook."
Roman Musatkin
,
Head of Product & Design
Swarmia
Build knowledge that never stands still
Join the thousands of teams using GitBook and create documentation that evolves alongside your product
Build knowledge that never stands still
Join the thousands of teams using GitBook and create documentation that evolves alongside your product
Build knowledge that never stands still
Join the thousands of teams using GitBook and create documentation that evolves alongside your product
Documentation
© 2025 Copyright GitBook INC.
440 N Barranca Ave #7171, Covina, CA 91723, USA. EIN: 320502699
Documentation
© 2025 Copyright GitBook INC.
440 N Barranca Ave #7171, Covina, CA 91723, USA. EIN: 320502699