mirror of
				https://github.com/mermaid-js/mermaid.git
				synced 2025-11-04 04:44:08 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			226 lines
		
	
	
		
			15 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
			
		
		
	
	
			226 lines
		
	
	
		
			15 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
# mermaid [](https://travis-ci.org/mermaid-js/mermaid) [](https://www.npmjs.com/package/mermaid) [](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) [](https://percy.io/Mermaid/mermaid)
 | 
						|
 | 
						|
<p align="center">
 | 
						|
    <a href="https://www.buymeacoffee.com/knsv" rel="nofollow">
 | 
						|
        <img src="https://user-images.githubusercontent.com/30767528/63641973-9d301680-c6b7-11e9-9d29-2ad1da50fdce.png" style="max-width:100%;" />
 | 
						|
    </a>
 | 
						|
</p>
 | 
						|
 | 
						|

 | 
						|
 | 
						|
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/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 🙏**
 | 
						|
 | 
						|
## About
 | 
						|
 | 
						|
<!-- <Main description>   -->
 | 
						|
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. <br/>
 | 
						|
Mermaid addresses this problem by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content.
 | 
						|
The text definitions for Mermaid diagrams allows for it to be updated easily, it can also be made part of production scripts (and other pieces of code).
 | 
						|
So less time needs to be spent on documenting, as a separate and laborious task. <br/>
 | 
						|
Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor).<br/>
 | 
						|
[Tutorials](./docs/Tutorials.md) has video tutorials.
 | 
						|
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md).
 | 
						|
 | 
						|
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/n00b-overview.md) and [Usage](./docs/usage.md).
 | 
						|
 | 
						|
🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | 📜 [Changelog](./docs/CHANGELOG.md)
 | 
						|
 | 
						|
<!-- </Main description> -->
 | 
						|
 | 
						|
## Examples
 | 
						|
 | 
						|
__The following are some examples of the diagrams, charts and graphs that can be made using Mermaid and the Markdown-inspired text specific to it. Click here jump into the [text syntax](https://mermaid-js.github.io/mermaid/#/n00b-syntaxReference).__
 | 
						|
<table>
 | 
						|
<!-- <Flowchart> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>Flow</b></br>
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/flowchart">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0hhcmRdIC0tPnxUZXh0fCBCKFJvdW5kKVxuICAgIEIgLS0-IEN7RGVjaXNpb259XG4gICAgQyAtLT58T25lfCBEW1Jlc3VsdCAxXVxuICAgIEMgLS0-fFR3b3wgRVtSZXN1bHQgMl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td><pre>
 | 
						|
graph TD
 | 
						|
A[Hard] -->|Text| B(Round)
 | 
						|
B --> C{Decision}
 | 
						|
C -->|One| D[Result 1]
 | 
						|
C -->|Two| E[Result 2]
 | 
						|
    </pre></td>
 | 
						|
    <td align="center">
 | 
						|
        <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-flow.png" />
 | 
						|
    </td>
 | 
						|
</tr>
 | 
						|
<!-- </Flowchart> -->
 | 
						|
<!-- <Sequence> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>Sequence</b><br />
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/sequenceDiagram">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5BbGljZS0-PkpvaG46IEhlbGxvIEpvaG4sIGhvdyBhcmUgeW91P1xubG9vcCBIZWFsdGhjaGVja1xuICAgIEpvaG4tPj5Kb2huOiBGaWdodCBhZ2FpbnN0IGh5cG9jaG9uZHJpYVxuZW5kXG5Ob3RlIHJpZ2h0IG9mIEpvaG46IFJhdGlvbmFsIHRob3VnaHRzIVxuSm9obi0tPj5BbGljZTogR3JlYXQhXG5Kb2huLT4-Qm9iOiBIb3cgYWJvdXQgeW91P1xuQm9iLS0-PkpvaG46IEpvbGx5IGdvb2QhIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td><pre>
 | 
						|
sequenceDiagram
 | 
						|
Alice->>John: Hello John, how are you?
 | 
						|
loop Healthcheck
 | 
						|
    John->>John: Fight against hypochondria
 | 
						|
end
 | 
						|
Note right of John: Rational thoughts!
 | 
						|
John-->>Alice: Great!
 | 
						|
John->>Bob: How about you?
 | 
						|
Bob-->>John: Jolly good!
 | 
						|
    </pre></td>
 | 
						|
    <td align="center">
 | 
						|
        <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-sequence.png" />
 | 
						|
    </td>
 | 
						|
</tr>
 | 
						|
<!-- </Sequence> -->
 | 
						|
<!-- <Gantt> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>Gantt</b><br />
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/gantt">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ2FudHRcbnNlY3Rpb24gU2VjdGlvblxuQ29tcGxldGVkIDpkb25lLCAgICBkZXMxLCAyMDE0LTAxLTA2LDIwMTQtMDEtMDhcbkFjdGl2ZSAgICAgICAgOmFjdGl2ZSwgIGRlczIsIDIwMTQtMDEtMDcsIDNkXG5QYXJhbGxlbCAxICAgOiAgICAgICAgIGRlczMsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAyICAgOiAgICAgICAgIGRlczQsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAzICAgOiAgICAgICAgIGRlczUsIGFmdGVyIGRlczMsIDFkXG5QYXJhbGxlbCA0ICAgOiAgICAgICAgIGRlczYsIGFmdGVyIGRlczQsIDFkIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td><pre>
 | 
						|
gantt
 | 
						|
section Section
 | 
						|
Completed :done,    des1, 2014-01-06,2014-01-08
 | 
						|
Active        :active,  des2, 2014-01-07, 3d
 | 
						|
Parallel 1   :         des3, after des1, 1d
 | 
						|
Parallel 2   :         des4, after des1, 1d
 | 
						|
Parallel 3   :         des5, after des3, 1d
 | 
						|
Parallel 4   :         des6, after des4, 1d
 | 
						|
    </pre></td>
 | 
						|
    <td align="center">
 | 
						|
        <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-gantt.png" />
 | 
						|
    </td>
 | 
						|
</tr>
 | 
						|
<!-- </Gantt> -->
 | 
						|
<!-- <Class> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>Class</b><br />
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/classDiagram">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiY2xhc3NEaWFncmFtXG5DbGFzczAxIDx8LS0gQXZlcnlMb25nQ2xhc3MgOiBDb29sXG48PGludGVyZmFjZT4-IENsYXNzMDFcbkNsYXNzMDkgLS0-IEMyIDogV2hlcmUgYW0gaT9cbkNsYXNzMDkgLS0qIEMzXG5DbGFzczA5IC0tfD4gQ2xhc3MwN1xuQ2xhc3MwNyA6IGVxdWFscygpXG5DbGFzczA3IDogT2JqZWN0W10gZWxlbWVudERhdGFcbkNsYXNzMDEgOiBzaXplKClcbkNsYXNzMDEgOiBpbnQgY2hpbXBcbkNsYXNzMDEgOiBpbnQgZ29yaWxsYVxuY2xhc3MgQ2xhc3MxMCB7XG4gID4-c2VydmljZT4-XG4gIGludCBpZFxuICBzaXplKClcbn0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td><pre>
 | 
						|
classDiagram
 | 
						|
Class01 <|-- AveryLongClass : Cool
 | 
						|
<<interface>> Class01
 | 
						|
Class09 --> C2 : Where am i?
 | 
						|
Class09 --* C3
 | 
						|
Class09 --|> Class07
 | 
						|
Class07 : equals()
 | 
						|
Class07 : Object[] elementData
 | 
						|
Class01 : size()
 | 
						|
Class01 : int chimp
 | 
						|
Class01 : int gorilla
 | 
						|
class Class10 {
 | 
						|
  <<service>>
 | 
						|
  int id
 | 
						|
  size()
 | 
						|
}
 | 
						|
</pre></td>
 | 
						|
    <td align="center">
 | 
						|
        <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-class.png" />
 | 
						|
    </td>
 | 
						|
</tr>
 | 
						|
<!-- </Class> -->
 | 
						|
<!-- <State> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>State</b><br />
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/stateDiagram">docs</a> - <a href="https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBTdGlsbFxuICAgIFN0aWxsIC0tPiBbKl1cbiAgICBTdGlsbCAtLT4gTW92aW5nXG4gICAgTW92aW5nIC0tPiBTdGlsbFxuICAgIE1vdmluZyAtLT4gQ3Jhc2hcbiAgICBDcmFzaCAtLT4gWypdIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQiLCJ0aGVtZVZhcmlhYmxlcyI6eyJiYWNrZ3JvdW5kIjoid2hpdGUiLCJwcmltYXJ5Q29sb3IiOiIjRUNFQ0ZGIiwic2Vjb25kYXJ5Q29sb3IiOiIjZmZmZmRlIiwidGVydGlhcnlDb2xvciI6ImhzbCg4MCwgMTAwJSwgOTYuMjc0NTA5ODAzOSUpIiwicHJpbWFyeUJvcmRlckNvbG9yIjoiaHNsKDI0MCwgNjAlLCA4Ni4yNzQ1MDk4MDM5JSkiLCJzZWNvbmRhcnlCb3JkZXJDb2xvciI6ImhzbCg2MCwgNjAlLCA4My41Mjk0MTE3NjQ3JSkiLCJ0ZXJ0aWFyeUJvcmRlckNvbG9yIjoiaHNsKDgwLCA2MCUsIDg2LjI3NDUwOTgwMzklKSIsInByaW1hcnlUZXh0Q29sb3IiOiIjMTMxMzAwIiwic2Vjb25kYXJ5VGV4dENvbG9yIjoiIzAwMDAyMSIsInRlcnRpYXJ5VGV4dENvbG9yIjoicmdiKDkuNTAwMDAwMDAwMSwgOS41MDAwMDAwMDAxLCA5LjUwMDAwMDAwMDEpIiwibGluZUNvbG9yIjoiIzMzMzMzMyIsInRleHRDb2xvciI6IiMzMzMiLCJtYWluQmtnIjoiI0VDRUNGRiIsInNlY29uZEJrZyI6IiNmZmZmZGUiLCJib3JkZXIxIjoiIzkzNzBEQiIsImJvcmRlcjIiOiIjYWFhYTMzIiwiYXJyb3doZWFkQ29sb3IiOiIjMzMzMzMzIiwiZm9udEZhbWlseSI6IlwidHJlYnVjaGV0IG1zXCIsIHZlcmRhbmEsIGFyaWFsIiwiZm9udFNpemUiOiIxNnB4IiwibGFiZWxCYWNrZ3JvdW5kIjoiI2U4ZThlOCIsIm5vZGVCa2ciOiIjRUNFQ0ZGIiwibm9kZUJvcmRlciI6IiM5MzcwREIiLCJjbHVzdGVyQmtnIjoiI2ZmZmZkZSIsImNsdXN0ZXJCb3JkZXIiOiIjYWFhYTMzIiwiZGVmYXVsdExpbmtDb2xvciI6IiMzMzMzMzMiLCJ0aXRsZUNvbG9yIjoiIzMzMyIsImVkZ2VMYWJlbEJhY2tncm91bmQiOiIjZThlOGU4IiwiYWN0b3JCb3JkZXIiOiJoc2woMjU5LjYyNjE2ODIyNDMsIDU5Ljc3NjUzNjMxMjglLCA4Ny45MDE5NjA3ODQzJSkiLCJhY3RvckJrZyI6IiNFQ0VDRkYiLCJhY3RvclRleHRDb2xvciI6ImJsYWNrIiwiYWN0b3JMaW5lQ29sb3IiOiJncmV5Iiwic2lnbmFsQ29sb3IiOiIjMzMzIiwic2lnbmFsVGV4dENvbG9yIjoiIzMzMyIsImxhYmVsQm94QmtnQ29sb3IiOiIjRUNFQ0ZGIiwibGFiZWxCb3hCb3JkZXJDb2xvciI6ImhzbCgyNTkuNjI2MTY4MjI0MywgNTkuNzc2NTM2MzEyOCUsIDg3LjkwMTk2MDc4NDMlKSIsImxhYmVsVGV4dENvbG9yIjoiYmxhY2siLCJsb29wVGV4dENvbG9yIjoiYmxhY2siLCJub3RlQm9yZGVyQ29sb3IiOiIjYWFhYTMzIiwibm90ZUJrZ0NvbG9yIjoiI2ZmZjVhZCIsIm5vdGVUZXh0Q29sb3IiOiJibGFjayIsImFjdGl2YXRpb25Cb3JkZXJDb2xvciI6IiM2NjYiLCJhY3RpdmF0aW9uQmtnQ29sb3IiOiIjZjRmNGY0Iiwic2VxdWVuY2VOdW1iZXJDb2xvciI6IndoaXRlIiwic2VjdGlvbkJrZ0NvbG9yIjoicmdiYSgxMDIsIDEwMiwgMjU1LCAwLjQ5KSIsImFsdFNlY3Rpb25Ca2dDb2xvciI6IndoaXRlIiwic2VjdGlvbkJrZ0NvbG9yMiI6IiNmZmY0MDAiLCJ0YXNrQm9yZGVyQ29sb3IiOiIjNTM0ZmJjIiwidGFza0JrZ0NvbG9yIjoiIzhhOTBkZCIsInRhc2tUZXh0TGlnaHRDb2xvciI6IndoaXRlIiwidGFza1RleHRDb2xvciI6IndoaXRlIiwidGFza1RleHREYXJrQ29sb3IiOiJibGFjayIsInRhc2tUZXh0T3V0c2lkZUNvbG9yIjoiYmxhY2siLCJ0YXNrVGV4dENsaWNrYWJsZUNvbG9yIjoiIzAwMzE2MyIsImFjdGl2ZVRhc2tCb3JkZXJDb2xvciI6IiM1MzRmYmMiLCJhY3RpdmVUYXNrQmtnQ29sb3IiOiIjYmZjN2ZmIiwiZ3JpZENvbG9yIjoibGlnaHRncmV5IiwiZG9uZVRhc2tCa2dDb2xvciI6ImxpZ2h0Z3JleSIsImRvbmVUYXNrQm9yZGVyQ29sb3IiOiJncmV5IiwiY3JpdEJvcmRlckNvbG9yIjoiI2ZmODg4OCIsImNyaXRCa2dDb2xvciI6InJlZCIsInRvZGF5TGluZUNvbG9yIjoicmVkIiwibGFiZWxDb2xvciI6ImJsYWNrIiwiZXJyb3JCa2dDb2xvciI6IiM1NTIyMjIiLCJlcnJvclRleHRDb2xvciI6IiM1NTIyMjIiLCJjbGFzc1RleHQiOiIjMTMxMzAwIiwiZmlsbFR5cGUwIjoiI0VDRUNGRiIsImZpbGxUeXBlMSI6IiNmZmZmZGUiLCJmaWxsVHlwZTIiOiJoc2woMzA0LCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJmaWxsVHlwZTMiOiJoc2woMTI0LCAxMDAlLCA5My41Mjk0MTE3NjQ3JSkiLCJmaWxsVHlwZTQiOiJoc2woMTc2LCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJmaWxsVHlwZTUiOiJoc2woLTQsIDEwMCUsIDkzLjUyOTQxMTc2NDclKSIsImZpbGxUeXBlNiI6ImhzbCg4LCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJmaWxsVHlwZTciOiJoc2woMTg4LCAxMDAlLCA5My41Mjk0MTE3NjQ3JSkifX0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td><pre>
 | 
						|
stateDiagram-v2
 | 
						|
[*] --> Still
 | 
						|
Still --> [*]
 | 
						|
Still --> Moving
 | 
						|
Moving --> Still
 | 
						|
Moving --> Crash
 | 
						|
Crash --> [*]
 | 
						|
</pre></td>
 | 
						|
    <td align="center">
 | 
						|
        <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-state.png" />
 | 
						|
    </td>
 | 
						|
</tr>
 | 
						|
<!-- </State> -->
 | 
						|
<!-- <Pie> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>Pie</b><br />
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/pie">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoicGllXG5cIkRvZ3NcIiA6IDQyLjk2XG5cIkNhdHNcIiA6IDUwLjA1XG5cIlJhdHNcIiA6IDEwLjAxIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td><pre>
 | 
						|
pie
 | 
						|
"Dogs" : 386
 | 
						|
"Cats" : 85
 | 
						|
"Rats" : 15
 | 
						|
</pre></td>
 | 
						|
    <td align="center">
 | 
						|
        <img src="https://raw.githubusercontent.com/mermaid-js/mermaid/master/img/gray-pie.png" />
 | 
						|
    </td>
 | 
						|
</tr>
 | 
						|
<!-- </Pie> -->
 | 
						|
<!-- <Git> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>Git</b><br />
 | 
						|
    [experimental - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ2l0R3JhcGg6XG5vcHRpb25zXG57XG4gICAgXCJub2RlU3BhY2luZ1wiOiAxNTAsXG4gICAgXCJub2RlUmFkaXVzXCI6IDEwXG59XG5lbmRcbmNvbW1pdFxuYnJhbmNoIG5ld2JyYW5jaFxuY2hlY2tvdXQgbmV3YnJhbmNoXG5jb21taXRcbmNvbW1pdFxuY2hlY2tvdXQgbWFzdGVyXG5jb21taXRcbmNvbW1pdFxubWVyZ2UgbmV3YnJhbmNoXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
    <td colspan="2" align="center"><i>Coming soon!</i></td>
 | 
						|
</tr>
 | 
						|
<!-- </Git> -->
 | 
						|
<!-- <Journey> -->
 | 
						|
<tr><td colspan=2 align="center">
 | 
						|
    <b>User Journey</b><br />
 | 
						|
    [<a href="http://mermaid-js.github.io/mermaid/#/user-journey">docs</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtXG4gICAgWypdIC0tPiBTdGlsbFxuICAgIFN0aWxsIC0tPiBbKl1cbiAgICBTdGlsbCAtLT4gTW92aW5nXG4gICAgTW92aW5nIC0tPiBTdGlsbFxuICAgIE1vdmluZyAtLT4gQ3Jhc2hcbiAgICBDcmFzaCAtLT4gWypdIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
 | 
						|
</td></tr>
 | 
						|
<tr>
 | 
						|
  <td>
 | 
						|
  <pre>
 | 
						|
  journey
 | 
						|
    title My working day
 | 
						|
    section Go to work
 | 
						|
      Make tea: 5: Me
 | 
						|
      Go upstairs: 3: Me
 | 
						|
      Do work: 1: Me, Cat
 | 
						|
    section Go home
 | 
						|
      Go downstairs: 5: Me
 | 
						|
      Sit down: 3: Me
 | 
						|
</pre></td>
 | 
						|
  <td align="center">
 | 
						|
    <img alt="User Journey Diagram" src="img/gray-user-journey.png" />
 | 
						|
  </td>
 | 
						|
</tr>
 | 
						|
<!-- </Journey> -->
 | 
						|
 | 
						|
</table>
 | 
						|
 | 
						|
## Related projects
 | 
						|
 | 
						|
- [Command Line Interface](https://github.com/mermaid-js/mermaid-cli)
 | 
						|
- [Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
 | 
						|
- [HTTP Server](https://github.com/TomWright/mermaid-server)
 | 
						|
 | 
						|
## Contributors [](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Help+wanted%21%22) [](https://github.com/mermaid-js/mermaid/graphs/contributors) [](https://github.com/mermaid-js/mermaid/graphs/contributors)
 | 
						|
 | 
						|
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](https://github.com/mermaid-js/mermaid/issues/866) if you want to know where to start helping out.
 | 
						|
 | 
						|
Detailed information about how to contribute can be found in the [contribution guide](CONTRIBUTING.md)
 | 
						|
 | 
						|
## Appreciation
 | 
						|
A quick note from Knut Sveidqvist:
 | 
						|
>*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.*
 | 
						|
>*Thank you to [Tyler Long](https://github.com/tylerlong) who has been a collaborator since April 2017.*
 | 
						|
>
 | 
						|
>*Thank you to the ever-growing list of [contributors](https://github.com/knsv/mermaid/graphs/contributors) that brought the project this far!*
 | 
						|
 | 
						|
---
 | 
						|
 | 
						|
*Mermaid was created by Knut Sveidqvist for easier documentation.*
 |