Skip to content
Generation of diagram and flowchart from text in a similar manner as markdown
JavaScript Yacc HTML CSS
Branch: master
Clone or download
Latest commit e461b57 Nov 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Updating the repo path after migration to mermaid-js Oct 30, 2019
.vscode #989 Added font styling classes to diagrams lacking then Oct 13, 2019
__mocks__ fix: workaround for function 25 line limit Jul 24, 2019
cypress #1023 Fix for interaction tests Nov 7, 2019
dist #945 Increasing size, handling forks and joins in multiple directions Oct 10, 2019
docs Fixed typos Nov 18, 2019
img Reworked readme (#1045) Nov 1, 2019
src #1023 Fix for tests Nov 7, 2019
.ackrc Update config files Mar 6, 2018
.editorconfig Add .editorconfig Apr 10, 2017
.eslintignore #1031 Adding stricter code checks Oct 27, 2019
.eslintrc.json #1031 Adding stricter code checks Oct 27, 2019
.gitignore Added package-lock to gitignore Oct 24, 2019
.percy.yml Adding percy badge Sep 11, 2019
.prettierrc #931 added conf and libraries Sep 12, 2019
.tern-project #926 Adding e2e tools for replicating issues Sep 8, 2019
.travis.yml Adding build to travis steps Sep 18, 2019
CHANGELOG.md Release docs Jul 21, 2019
CONTRIBUTING.md Update some path changes after repo move Oct 30, 2019
LICENSE Update todo list Mar 8, 2018
README.md Added npm badge (#1047) Nov 3, 2019
babel.config.js Adding image snapshots for graphs May 31, 2019
cypress.json #927 Adding support for cypress and Percy Sep 11, 2019
jest.config.js Cleanup, removed old e2e in favour of cypress Sep 18, 2019
jisonLoader.js chore: integrate jison into webpack build Aug 3, 2019
jisonTransformer.js chore: integrate jison into webpack build Aug 3, 2019
package.json Updated version Nov 7, 2019
todo.md Update todo list Apr 11, 2018
transformer.js Fixed tests Apr 26, 2019
webpack.config.babel.js Get rid of babel-preset-es2015 Dec 20, 2017
webpack.config.base.js chore: integrate jison into webpack build Aug 3, 2019
webpack.config.e2e.js Cleanup, removed old e2e in favour of cypress Sep 18, 2019
webpack.config.prod.babel.js Update some dependencies Mar 6, 2018
yarn.lock Use dagre-d3 master branch (for d3v5) Oct 21, 2019

README.md

📣 📣 📣
* If you're upgrading from a version < v8.2.0, there are non-backward-compatible changes related to security issues. Default behaviour of the library might have changed for your implementation.

mermaid Build Status NPM Coverage Status Join our Slack! This project is using Percy.io for visual regression testing.

Generate diagrams, charts, graphs or flows from markdown-like text via javascript. See our documentation and start simplifying yours. Play in our live editor or jump straight to the installation and usage.

🏆 "The most exciting use of technology" - JS Open Source Awards (2019)

Flow
[docs - live editor]
graph TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
    
Sequence
[docs - live editor]
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!
    
Gantt
[docs - live editor]
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
    
Class
[docs - live editor]
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()
}
State
[docs - live editor]
stateDiagram
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
Pie
[docs - live editor]
pie
"Dogs" : 386
"Cats" : 85
"Rats" : 15 
Git
[experimental - live editor]
Coming soon!

Related projects

Contributors Help wanted Contributors Commits

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 if you want to know where to start helping out.

Detailed information about how to contribute can be found in the contribution guide

Appreciation

A quick note from Knut Sveidqvist:

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. Thank you to Tyler Long who has been a collaborator since April 2017.

Thank you to the ever-growing list of contributors that brought the project this far!


Mermaid was created by Knut Sveidqvist for easier documentation.

You can’t perform that action at this time.