mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-01-28 07:03:17 +08:00
100 lines
3.8 KiB
Markdown
100 lines
3.8 KiB
Markdown
---
|
|
order: 0
|
|
---
|
|
|
|
mermaid
|
|
=======
|
|
|
|
|
|
>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. [Try it using our editor](http://knsv.github.io/mermaid/live_editor).
|
|
|
|
|
|
Code examples below:
|
|
|
|
### An example of a flowchart
|
|
```
|
|
graph TD;
|
|
A-->B;
|
|
A-->C;
|
|
B-->D;
|
|
C-->D;
|
|
```
|
|
|
|
### An example of a sequence diagram
|
|
```
|
|
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 code for a gantt diagram
|
|
```
|
|
gantt
|
|
dateFormat YYYY-MM-DD
|
|
title Adding GANTT diagram functionality to mermaid
|
|
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
|
|
Future task2 : des4, after des3, 5d
|
|
section Critical tasks
|
|
Completed task in the critical line :crit, done, 2014-01-06,24h
|
|
Implement parser and jison :crit, done, after des1, 2d
|
|
Create tests for parser :crit, active, 3d
|
|
Future task in critical line :crit, 5d
|
|
Create tests for renderer :2d
|
|
Add to mermaid :1d
|
|
```
|
|
|
|
Play with mermaid using this [editor](http://danielmschmidt.github.io/mermaid-demo/) or this [live editor](live_editor).
|
|
|
|
## Credits
|
|
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.
|
|
|
|
*Mermaid was created by Knut Sveidqvist for easier documentation.*
|
|
|
|
Knut has not done all work by himself, here is the full list of the projects [contributors](https://github.com/knsv/mermaid/graphs/contributors).
|
|
|
|
# Downstream projects
|
|
|
|
Mermaid is supported in a number of publishing systems and editors. Please report if a plugin/editor is missing from the list below:
|
|
|
|
* Support in LightPaper 1.2+. [Howto](https://github.com/42Squares/LightPaper/blob/master/doc/Adding%20Mermaid%20Diagrams.md). Discout with code MERMAID_25
|
|
* [gitbook-plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid)
|
|
* light table
|
|
* [Confluence plugin](https://marketplace.atlassian.com/plugins/org.anvard.atlassian.mermaid-plugin/server/overview)
|
|
* [Using mermaid via docpad](http://nauvalatmaja.com/2015/01/13/rendering-mermaid-in-docpad/)
|
|
* [Using mermaid in Jekyll](https://rubygems.org/gems/jekyll-mermaid/versions/1.0.0)
|
|
* [Using mermaid via Octopress](http://mostlyblather.com/blog/2015/05/23/mermaid-jekyll-octopress/)
|
|
* [Mardown editor Haroopad](http://pad.haroopress.com/user.html)
|
|
* [Plugin for atom](https://atom.io/packages/atom-mermaid)
|
|
* [Markdown Plus](http://mdp.tylingsoft.com/)
|
|
* [Vim Plugin](https://github.com/kannokanno/previm)
|
|
* [Sphinx extension](https://github.com/mgaitan/sphinxcontrib-mermaid)
|
|
|
|
# Online live editor
|
|
|
|
An editor is available for creating diagrams. With it you can quickly start writing mermaid diagrams. It is possible to:
|
|
|
|
* save the result as a svg
|
|
* get a link to a viewer of the diagram
|
|
* get a link to edit of the diagram to share a diagram so that someone else can tweak it and send a new link back
|
|
|
|
* [Editor](http://knsv.github.io/mermaid/live_editor)
|