Use Mermaid with your favorite applications, check out the list of Integrations and Usages of Mermaid.įor a more detailed introduction to Mermaid and some of its more basic uses, look to the Beginner's Guide and Usage. So less time needs to be spent on documenting, as a separate and laborious task.Įven non-programmers can create diagrams through the Mermaid Live Editor. The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code). Mermaid addresses this problem by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content.
The main purpose of Mermaid is to help documentation catch up with development.ĭoc-Rot is a Catch-22 that Mermaid helps to solve.ĭiagramming and documentation costs precious developer time and gets outdated quickly.īut not having diagrams or docs ruins productivity and hurts organizational learning. Mermaid is a Javascript based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. Thanks to all involved, people committing pull requests, people answering questions! 🙏 🏆 Mermaid was nominated and won the JS Open Source Awards (2019) in the category 'The most exciting use of technology'!!!
