2017-04-21 14:31:49 +02:00
# mermaid [![Build Status](https://travis-ci.org/knsv/mermaid.svg?branch=master)](https://travis-ci.org/knsv/mermaid)
2015-06-07 21:09:09 +02:00
2017-04-21 14:31:49 +02:00
[![Code Climate ](https://codeclimate.com/github/knsv/mermaid/badges/gpa.svg )](https://codeclimate.com/github/knsv/mermaid)
2015-10-23 20:12:08 +02:00
[![Join the chat at https://gitter.im/knsv/mermaid ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/knsv/mermaid?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge& utm_content=badge)
2014-11-16 19:00:01 +01:00
Generation of diagrams and flowcharts from text in a similar manner as markdown.
2014-11-02 01:01:23 +01:00
2014-11-16 19:00:01 +01:00
Ever wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?
2014-11-02 01:01:23 +01:00
2014-11-15 21:28:26 +01:00
This is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript.
2014-11-02 01:01:23 +01:00
2014-11-16 19:00:01 +01:00
The code below would render the following image
2014-12-22 13:22:45 +01:00
< table >
2016-07-27 13:29:15 +02:00
< tr > < th > Code< / th > < th > Rendered diagram< / th > < / tr >
< tr >
< td >
< pre >
< code >
2016-07-27 13:31:21 +02:00
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
2016-07-27 13:29:15 +02:00
< / code >
< / pre >
< / td >
2016-07-27 13:55:39 +02:00
< td >
< p align = "center" >
< img src = 'http://www.sveido.com/mermaid/img/ex1.png' alt = 'Example 1' >
< / p >
2016-07-27 13:29:15 +02:00
< / td >
< / tr >
< tr >
< td >
< pre >
< code >
2016-07-27 13:31:21 +02:00
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
2016-07-27 13:57:50 +02:00
John->>John: Fight against hypochondria
2016-07-27 13:31:21 +02:00
end
Note right of John: Rational thoughts < br/>prevail...
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
2016-07-27 13:29:15 +02:00
< / code >
< / pre >
< / td >
< td >
< img src = 'http://www.sveido.com/mermaid/img/seq1.png' alt = 'Example 2' >
< / td >
< / tr >
< tr >
< td >
< pre >
< code >
2016-07-27 13:31:21 +02:00
classDiagram
2017-03-24 21:27:26 +01:00
Class01 < |-- AveryLongClass : Cool
2016-07-27 13:31:21 +02:00
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
2017-03-24 21:27:26 +01:00
Class08 < --> C2: Cool label
2016-07-27 13:29:15 +02:00
< / code >
< / pre >
< / td >
< td >
< img src = './docs/img/class-diagram.png' alt = 'Example 3' >
< / td >
< / tr >
2017-02-21 08:02:19 +01:00
< tr >
< td >
< pre >
< code >
gitGraph :
options
{
"key": "value",
"nodeWidth": 150,
"nodeSpacing" : 150
}
end
commit
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
< / code >
< / pre >
< / td >
< td >
< img src = './docs/img/gitgraph.mm.png' alt = 'Example 4' >
< / td >
< / tr >
2014-12-22 13:22:45 +01:00
< / table >
2014-11-15 21:28:26 +01:00
2017-04-21 14:31:49 +02:00
2014-12-31 11:32:25 +01:00
## Further reading
2014-12-21 02:46:23 +01:00
2015-10-30 07:06:36 +01:00
* [Usage ](http://knsv.github.io/mermaid/#usage )
* [Flowchart syntax ](http://knsv.github.io/mermaid/#flowcharts-basic-syntax )
* [Sequence diagram syntax ](http://knsv.github.io/mermaid/#sequence-diagrams )
* [Mermaid client ](http://knsv.github.io/mermaid/#mermaid-cli )
* [Demos ](http://knsv.github.io/mermaid/#demos )
2014-12-03 20:03:15 +01:00
2017-04-21 14:31:49 +02:00
2017-04-01 13:51:03 +02:00
# Request for assistance
Things are piling up and I have hard time keeping up. To remedy this
it would be great if we could form a core team of developers to cooperate
with the future development mermaid.
As part of this team you would get write access to the repository and would
represent the project when answering questions and issues.
Together we could continue the work with things like:
* port the code to es6
* improved support for webpack
* modernizing the build
* adding more typers of diagrams like mindmaps, ert digrams etc
* improving existing diagrams
Don't hesitate to contact me if you want to get involved.
2017-04-21 14:31:49 +02:00
# For contributors
## Setup
Make sure you have Chrome browser installed, this project uses Chrome headless to running tests.
yarn install
## Build
yarn build
If you want real time incremental build:
yarn watch
## Lint
yarn lint
We use [JavaScript Standard Style ](https://github.com/feross/standard ).
We recommend you installing [editor plugins ](https://github.com/feross/standard#are-there-text-editor-plugins ) so you can get real time lint result.
## Test
yarn test
2017-04-21 14:49:35 +02:00
Manual test in browser:
open dist/demo/index.html
Manual test in Node.js:
node dist/demo/index.js
2017-04-21 14:31:49 +02:00
## Distribtion
yarn dist
Command above generates files into the `dist` folder, then you can publish them to npmjs.org.
2014-11-15 21:28:26 +01:00
# Credits
2017-04-21 14:31:49 +02:00
Many thanks to the [d3 ](http://d3js.org/ ) and [dagre-d3 ](https://github.com/cpettitt/dagre-d3 ) projects for providing the graphical layout and drawing libraries!
Thanks also to the [js-sequence-diagram ](http://bramp.github.io/js-sequence-diagrams ) project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering.
2014-12-12 19:05:27 +01:00
*Mermaid was created by Knut Sveidqvist for easier documentation.*
2014-12-31 11:32:25 +01:00
Knut has not done all work by him self, here is the full list of the projects [contributors ](https://github.com/knsv/mermaid/graphs/contributors ).