Mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a ...

ChartingD3Diagram / Flow chart
mermaid-js/mermaidmermaid-js.github.io/mermaid/mermaid

README

mermaid

Build CI Status NPM Coverage Status CDN Status NPM Join our Slack! Twitter Follow

Whoa, what's going on here?


We are transforming the Mermaid repository to a so called mono-repo. This is a part of the effort to decouple the diagrams from the core of mermaid. This will:

- Make it possible to select which diagrams to include on your site
- Open up for lazy loading
- Make it possible to add diagrams from outside of the Mermaid repository
- Separate the release flow between different diagrams and the Mermaid core

As such be aware of some changes..

We use pnpm now


The source code has moved


It is now located in the src folder for each respective package located as subfolders in packages.

English | 简体中文


: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! 🙏

Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!

About




Mermaid is a JavaScript-based diagramming and charting tool that uses Markdown-inspired text definitions and a renderer to create and modify complex diagrams. The main purpose of Mermaid is to help documentation catch up with development.

Doc-Rot is a Catch-22 that Mermaid helps to solve.


Diagramming and documentation costs precious developer time and gets outdated quickly.
But not having diagrams or docs ruins productivity and hurts organizational learning.
Mermaid addresses this problem by enabling users to create easily modifiable diagrams. It can also be made part of production scripts (and other pieces of code).


Mermaid allows even non-programmers to easily create detailed diagrams through the [Mermaid Live Editor](https://mermaid.live/).
Tutorials has video tutorials.
Use Mermaid with your favorite applications, check out the list of Integrations and Usages of Mermaid.

You can also use Mermaid within GitHub as well many of your other favorite applications—check out the list of Integrations and Usages of Mermaid.

For a more detailed introduction to Mermaid and some of its more basic uses, look to the Beginner's Guide, Usage and Tutorials.

🌐 CDN | 📖 Documentation | 🙌 Contribution | 📜 Changelog

In our release process we rely heavily on visual regression tests using applitools. Applitools is a great service which has been easy to use and integrate with our tests.




Examples


The following are some examples of the diagrams, charts and graphs that can be made using Mermaid. Click here to jump into the text syntax.



### Flowchart [docs - live editor]

  1. ```
  2. flowchart LR

  4. A[Hard] -->|Text| B(Round)
  5. B --> C{Decision}
  6. C -->|One| D[Result 1]
  7. C -->|Two| E[Result 2]
  8. ```

  1. ```mermaid
  2. flowchart LR

  4. A[Hard] -->|Text| B(Round)
  5. B --> C{Decision}
  6. C -->|One| D[Result 1]
  7. C -->|Two| E[Result 2]
  8. ```

### Sequence diagram [docs - live editor]

  1. ```
  2. sequenceDiagram
  3. Alice->>John: Hello John, how are you?
  4. loop Healthcheck
  5.     John->>John: Fight against hypochondria
  6. end
  7. Note right of John: Rational thoughts!
  8. John-->>Alice: Great!
  9. John->>Bob: How about you?
  10. Bob-->>John: Jolly good!
  11. ```

  1. ```mermaid
  2. sequenceDiagram
  3. Alice->>John: Hello John, how are you?
  4. loop Healthcheck
  5.     John->>John: Fight against hypochondria
  6. end
  7. Note right of John: Rational thoughts!
  8. John-->>Alice: Great!
  9. John->>Bob: How about you?
  10. Bob-->>John: Jolly good!
  11. ```

### Gantt chart [docs - live editor]

  1. ```
  2. gantt
  3.     section Section
  4.     Completed :done,    des1, 2014-01-06,2014-01-08
  5.     Active        :active,  des2, 2014-01-07, 3d
  6.     Parallel 1   :         des3, after des1, 1d
  7.     Parallel 2   :         des4, after des1, 1d
  8.     Parallel 3   :         des5, after des3, 1d
  9.     Parallel 4   :         des6, after des4, 1d
  10. ```

  1. ```mermaid
  2. gantt
  3.     section Section
  4.     Completed :done,    des1, 2014-01-06,2014-01-08
  5.     Active        :active,  des2, 2014-01-07, 3d
  6.     Parallel 1   :         des3, after des1, 1d
  7.     Parallel 2   :         des4, after des1, 1d
  8.     Parallel 3   :         des5, after des3, 1d
  9.     Parallel 4   :         des6, after des4, 1d
  10. ```

### Class diagram [docs - live editor]

  1. ```
  2. classDiagram
  3. Class01 <|-- AveryLongClass : Cool
  4. <<Interface>> Class01
  5. Class09 --> C2 : Where am I?
  6. Class09 --* C3
  7. Class09 --|> Class07
  8. Class07 : equals()
  9. Class07 : Object[] elementData
  10. Class01 : size()
  11. Class01 : int chimp
  12. Class01 : int gorilla
  13. class Class10 {
  14.   <<service>>
  15.   int id
  16.   size()
  17. }
  18. ```

  1. ```mermaid
  2. classDiagram
  3. Class01 <|-- AveryLongClass : Cool
  4. <<Interface>> Class01
  5. Class09 --> C2 : Where am I?
  6. Class09 --* C3
  7. Class09 --|> Class07
  8. Class07 : equals()
  9. Class07 : Object[] elementData
  10. Class01 : size()
  11. Class01 : int chimp
  12. Class01 : int gorilla
  13. class Class10 {
  14.   <<service>>
  15.   int id
  16.   size()
  17. }
  18. ```

### State diagram [docs - live editor]

  1. ```
  2. stateDiagram-v2
  3. [*] --> Still
  4. Still --> [*]
  5. Still --> Moving
  6. Moving --> Still
  7. Moving --> Crash
  8. Crash --> [*]
  9. ```

  1. ```mermaid
  2. stateDiagram-v2
  3. [*] --> Still
  4. Still --> [*]
  5. Still --> Moving
  6. Moving --> Still
  7. Moving --> Crash
  8. Crash --> [*]
  9. ```

### Pie chart [docs - live editor]

  1. ```
  2. pie
  3. "Dogs" : 386
  4. "Cats" : 85.9
  5. "Rats" : 15
  6. ```

  1. ```mermaid
  2. pie
  3. "Dogs" : 386
  4. "Cats" : 85.9
  5. "Rats" : 15
  6. ```

### Git graph [experimental - live editor]

### User Journey diagram [docs - live editor]

  1. ```
  2.   journey
  3.     title My working day
  4.     section Go to work
  5.       Make tea: 5: Me
  6.       Go upstairs: 3: Me
  7.       Do work: 1: Me, Cat
  8.     section Go home
  9.       Go downstairs: 5: Me
  10.       Sit down: 3: Me
  11. ```

  1. ```mermaid
  2.   journey
  3.     title My working day
  4.     section Go to work
  5.       Make tea: 5: Me
  6.       Go upstairs: 3: Me
  7.       Do work: 1: Me, Cat
  8.     section Go home
  9.       Go downstairs: 5: Me
  10.       Sit down: 3: Me
  11. ```

### C4 diagram [docs]

  1. ```
  2. C4Context
  3. title System Context diagram for Internet Banking System

  5. Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
  6. Person(customerB, "Banking Customer B")
  7. Person_Ext(customerC, "Banking Customer C")
  8. System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")

  10. Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")

  12. Enterprise_Boundary(b1, "BankBoundary") {

  14.   SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")

  16.   System_Boundary(b2, "BankBoundary2") {
  17.     System(SystemA, "Banking System A")
  18.     System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts.")
  19.   }

  21.   System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
  22.   SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")

  24.   Boundary(b3, "BankBoundary3", "boundary") {
  25.     SystemQueue(SystemF, "Banking System F Queue", "A system of the bank, with personal bank accounts.")
  26.     SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
  27.   }
  28. }

  30. BiRel(customerA, SystemAA, "Uses")
  31. BiRel(SystemAA, SystemE, "Uses")
  32. Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
  33. Rel(SystemC, customerA, "Sends e-mails to")
  34. ```

  1. ```mermaid
  2. C4Context
  3. title System Context diagram for Internet Banking System

  5. Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
  6. Person(customerB, "Banking Customer B")
  7. Person_Ext(customerC, "Banking Customer C")
  8. System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")

  10. Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")

  12. Enterprise_Boundary(b1, "BankBoundary") {

  14.   SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")

  16.   System_Boundary(b2, "BankBoundary2") {
  17.     System(SystemA, "Banking System A")
  18.     System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts.")
  19.   }

  21.   System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
  22.   SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")

  24.   Boundary(b3, "BankBoundary3", "boundary") {
  25.     SystemQueue(SystemF, "Banking System F Queue", "A system of the bank, with personal bank accounts.")
  26.     SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
  27.   }
  28. }

  30. BiRel(customerA, SystemAA, "Uses")
  31. BiRel(SystemAA, SystemE, "Uses")
  32. Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
  33. Rel(SystemC, customerA, "Sends e-mails to")
  34. ```

Release


For those who have the permission to do so:

Update version number in package.json.

  1. ```sh
  2. npm publish
  3. ```

The above command generates files into the dist folder and publishes them to npmjs.org.

Related projects


- Command Line Interface
- Live Editor
- HTTP Server

Contributors Good first issue Contributors Commits


Mermaid is a growing community and is always accepting new contributors. There's a lot of different ways to help out and we're always looking for extra hands! Look at this issue if you want to know where to start helping out.

Detailed information about how to contribute can be found in the contribution guide

Security and safe diagrams


For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitise the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes.

As an extra level of security for sites with external users we are happy to introduce a new security level in which the diagram is rendered in a sandboxed iframe preventing javascript in the code from being executed. This is a great step forward for better security.

_Unfortunately you can not have a cake and eat it at the same time which in this case means that some of the interactive functionality gets blocked along with the possible malicious code._

Reporting vulnerabilities


To report a vulnerability, please e-mail security@mermaid.live with a description of the issue, the steps you took to create the issue, affected versions, and if known, mitigations for the issue.

Appreciation


A quick note from Knut Sveidqvist:

_Many thanks to the d3 and dagre-d3 projects for providing the graphical layout and drawing libraries!_ >_Thanks also to the js-sequence-diagram project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering._ >_Thank you to Tyler Long who has been a collaborator since April 2017._

>

_Thank you to the ever-growing list of contributors that brought the project this far!_



_Mermaid was created by Knut Sveidqvist for easier documentation._