2017-08-16 18:03:06 +02:00
[![Build Status ](https://travis-ci.org/knsv/mermaid.svg?branch=master )](https://travis-ci.org/knsv/mermaid)
2018-03-10 01:54:28 +01:00
[![Coverage Status ](https://coveralls.io/repos/github/knsv/mermaid/badge.svg?branch=master )](https://coveralls.io/github/knsv/mermaid?branch=master)
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)
2019-09-11 22:57:53 +02:00
[![This project is using Percy.io for visual regression testing. ](https://percy.io/static/images/percy-badge.svg )](https://percy.io/Mermaid/mermaid)
2015-10-23 20:12:08 +02:00
2019-06-29 16:14:31 +02:00
# mermaid
2019-07-21 11:23:23 +02:00
## Special note regarding version 8.2
2019-07-21 18:16:47 +02:00
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.
2019-07-21 11:23:23 +02:00
2019-07-21 18:46:35 +02:00
* **`strict`**: (default) tags in text are encoded, click functionality is disabled
2019-09-19 09:45:13 +02:00
* `loose` : tags in text are allowed, click functionality is enabled
2019-07-21 11:23:23 +02:00
⚠️ **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.
2019-08-22 12:53:26 +02:00
If your application is taking responsibility for the diagram source security you can set the securityLevel accordingly. By doing this clicks and tags are again allowed.
2019-07-21 11:23:23 +02:00
```javascript
2019-09-19 09:45:13 +02:00
mermaidAPI.initialize({
securityLevel: 'loose'
});
2019-07-21 11:23:23 +02:00
```
2019-06-29 16:15:53 +02:00
**🖖 Keep a steady pulse: mermaid needs more Collaborators [#866 ](https://github.com/knsv/mermaid/issues/866 )**
2019-06-29 16:14:31 +02:00
2017-09-14 05:26:21 +02:00
![banner ](./img/header.png )
2017-09-01 09:53:20 +02:00
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
2019-08-22 12:53:26 +02:00
**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.**
2019-06-08 09:09:44 +02:00
2017-09-16 04:27:17 +02:00
### Flowchart
```
2016-07-27 13:31:21 +02:00
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
2017-09-16 04:27:17 +02:00
```
![Flowchart ](./img/flow.png )
### Sequence diagram
```
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
2019-06-15 09:38:02 +02:00
Note right of John: Rational thoughts < br / > prevail!
2016-07-27 13:31:21 +02:00
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
2017-09-16 04:27:17 +02:00
```
![Sequence diagram ](./img/sequence.png )
### Gantt diagram
```
2017-09-01 10:01:03 +02:00
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram to mermaid
2019-02-06 19:59:57 +01:00
excludes weekdays 2014-01-10
2017-09-01 10:01:03 +02:00
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
2019-09-19 09:45:13 +02:00
Future task2 : des4, after des3, 5d
2017-09-16 04:27:17 +02:00
```
![Gantt diagram ](./img/gantt.png )
2017-09-16 04:28:53 +02:00
### Class diagram - :exclamation: experimental
2017-09-16 04:27:17 +02:00
```
2016-07-27 13:31:21 +02:00
classDiagram
2017-09-16 04:27:17 +02:00
Class01 < |-- AveryLongClass : Cool
2019-10-04 23:49:58 +02:00
< < interface > > Class01
2017-09-16 04:27:17 +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
Class08 < -- > C2: Cool label
2019-10-04 23:49:58 +02:00
class Class10 {
< < service > >
int id
size()
}
2017-09-16 04:27:17 +02:00
```
![Class diagram ](./img/class.png )
2017-09-16 04:28:53 +02:00
### Git graph - :exclamation: experimental
2017-09-16 04:27:17 +02:00
```
gitGraph:
2017-02-21 08:02:19 +01:00
options
{
2017-09-16 04:27:17 +02:00
"nodeSpacing": 150,
"nodeRadius": 10
2017-02-21 08:02:19 +01:00
}
end
2017-09-16 04:27:17 +02:00
commit
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch
```
![Git graph ](./img/git.png )
2014-11-15 21:28:26 +01:00
2017-04-21 14:31:49 +02:00
2017-06-04 06:21:13 +02:00
## Installation
### CDN
2019-09-19 09:45:13 +02:00
https://unpkg.com/mermaid@< version > /dist/
2017-06-04 06:21:13 +02:00
Replace `<version>` with expected version number.
2017-09-14 05:26:21 +02:00
Example: https://unpkg.com/mermaid@7.1.0/dist/
2017-06-04 06:21:13 +02:00
### Node.js
2019-09-19 09:45:13 +02:00
yarn add mermaid
2017-06-04 06:21:13 +02:00
2017-09-14 05:26:21 +02:00
## Documentation
2014-12-21 02:46:23 +01:00
2017-09-14 05:26:21 +02:00
https://mermaidjs.github.io
## Sibling projects
- [mermaid CLI ](https://github.com/mermaidjs/mermaid.cli )
- [mermaid live editor ](https://github.com/mermaidjs/mermaid-live-editor )
- [mermaid webpack demo ](https://github.com/mermaidjs/mermaid-webpack-demo )
2017-12-25 06:49:53 +01:00
- [mermaid Parcel demo ](https://github.com/mermaidjs/mermaid-parcel-demo )
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:
2019-03-18 11:48:18 +01:00
* adding more types of diagrams like mindmaps, ert diagrams etc
2017-04-01 13:51:03 +02:00
* 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
yarn install
## Build
2017-09-05 14:57:13 +02:00
yarn build:watch
2017-04-21 14:31:49 +02:00
## Lint
yarn lint
2019-10-06 09:02:07 +02:00
We use [eslint ](https://eslint.org/ ).
We recommend you installing [editor plugins ](https://eslint.org/docs/user-guide/integrations ) so you can get real time lint result.
2017-04-21 14:31:49 +02:00
## Test
yarn test
2017-04-21 14:49:35 +02:00
Manual test in browser:
2017-12-20 15:02:21 +01:00
open dist/index.html
2017-04-21 14:49:35 +02:00
2017-04-21 14:31:49 +02:00
2017-06-04 09:26:45 +02:00
## Release
2017-04-21 14:31:49 +02:00
2017-09-14 05:26:21 +02:00
For those who have the permission to do so:
2017-08-16 17:19:44 +02:00
Update version number in `package.json` .
2017-06-04 09:26:45 +02:00
npm publish
2017-04-21 14:31:49 +02:00
2017-06-04 09:26:45 +02:00
Command above generates files into the `dist` folder and publishes them to npmjs.org.
2017-04-21 14:31:49 +02:00
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
2017-08-16 17:19:44 +02:00
*[Tyler Long](https://github.com/tylerlong) has became a collaborator since April 2017.*
Here is the full list of the projects [contributors ](https://github.com/knsv/mermaid/graphs/contributors ).