Skip to content
forked from mermaid-js/mermaid

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

License

Notifications You must be signed in to change notification settings

spect88/mermaid

 
 

Repository files navigation

mermaid Build Status Code Climate

Generation of diagrams and flowcharts from text in a similar manner as markdown.

Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?

This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript.

The code below would render the following image

CodeRendered diagram

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Example 1

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail...
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

Example 2

Further reading

Credits

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.

Mermaid was created by Knut Sveidqvist for easier documentation.

Knut has not done all work by him self, here is the full list of the projects contributors.

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.5%
  • Other 1.5%