Mermaid
Open-source JavaScript library that turns text definitions into flowcharts, sequence diagrams and other charts, supported in GitHub and many docs tools.

At a glance
Checked
- Pricing
- Free: the whole library, under the MIT licence
- Licence
- MIT, open source
- GitHub
- github.com/mermaid-js/mermaid91.2k stars · 9.5k forks · written in TypeScriptLatest release @mermaid-js/examples@2.1.0, 13 Nov 2026From GitHub, updated at every build
- Made by
- Knut Sveidqvist and contributors
- Platforms
- In the browser as a JavaScript library, with the Mermaid Live Editor at mermaid.live
- Website
- mermaid.js.org
What it’s good for
Mermaid draws diagrams from text. You write a few lines naming the boxes and the arrows between them, and the library renders a flowchart, sequence diagram, Gantt chart, user journey, mind map or one of about thirty other types. Because the source is plain text, a user flow can sit in a Markdown file and change in the same commit as the code it describes.
GitHub, GitLab, Notion and Obsidian are among the tools its integrations list marks as rendering Mermaid natively, so a diagram in a README or wiki needs no exported image. Drafts are quickest in the Mermaid Live Editor in the browser; on a site, install it from npm or load it from jsDelivr. The library is open source under MIT.
Alternatives to Mermaid
All Wireframing toolsQuestions
- Is Mermaid free?
- Yes. Mermaid is open source under the MIT licence, created by Knut Sveidqvist, and free to use in any project.
- Does GitHub support Mermaid diagrams?
- Yes. Mermaid's integrations list marks GitHub as supporting it natively through code blocks, so a Mermaid block in a Markdown file shows as a diagram. GitLab, Notion and Obsidian are listed with native support too.



