Github url

mermaid

by mermaid-js

mermaid-js /mermaid

Generation of diagram and flowchart from text in a similar manner as markdown

30.9K Stars 2.0K Forks Last release: 30 days ago (8.5.2) MIT License 2.4K Commits 60 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

| :mega: :mega: :mega: | | :----: | | * If you're upgrading from a version < v8.2.0, there are non-backward-compatible changes related to security issues. Default behaviour of the library might have changed for your implementation.| <!-- -->

mermaid Build Status NPM Coverage Status Join our Slack! This project is using Percy.io for visual regression testing.

mermaid is a Javascript based diagramming and charting tool. It generates diagrams flowcharts and more, using markdown-inspired text for ease and speed.

Check out the list of Integrations and Usages of Mermaid

For more information and help in getting started, please view our documentation and start simplifying yours. Alternatively, you can also play with our live editor. <!-- -->

:trophy: Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.

New diagram

This version comes with a new diagram type, user journey diagrams.

New diagrams in 8.4

With version 8.4 class diagrams have got some new features, bug fixes and documentation. Another new feature in 8.4 is the new diagram type, state diagrams.

Image show the two new diagram types

Special note regarding version 8.2

In version 8.2 a security improvement was introduced. A securityLevel configuration was introduced which sets the level of trust to be used on the parsed diagrams.

  • true: (default) tags in text are encoded, click functionality is disabled
  • false: tags in text are allowed, click functionality is enabled

Closed issues:

⚠️ Note : This changes the default behaviour of mermaid so that after upgrade to 8.2, if the securityLevel is not configured, tags in flowcharts are encoded as tags and clicking is prohibited.

If your application is taking resposibility for the diagram source security you can set the securityLevel accordingly. By doing this clicks and tags are again allowed.

mermaidAPI.initialize({ securityLevel: 'loose' });

For more information and help in getting started, please view our documentation and start simplifying yours. Play with our live editor or jump straight to the installation and usage. <!-- -->

The following are some examples of the diagrams, charts and graphs that can be made using mermaid and the Markdown-inspired text specific to it. Click here jump into the text syntax.

<!-- -->

Flow [docs - live editor]
graph TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
    
<!-- --\> \

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.