Mermaid was nominated and won the JS Open Source Awards (2019) in the category 'The most exciting use of technology'!!!

1. Typora Flowchart
2. Typora Graph
3. Typography Diagrams

Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project 🙏

I'm finding my sequence diagrams with Mermaid are too wide for printing (e.g. More than 4 actors using the Github theme). Mermaid can style diagrams with a stylesheet. What are your thoughts on adding support for some form of scaling sim.

About

Basicarrows tohead yields rightarrow yields leftarrow yields leftrightarrow yields Rightarrow yields Leftarrow yields Leftrightarrow yields Arrowsfrombar mapsto yields mapsto yields mapsfrom yields Mapsto yields Mapsfrom yields 3. Arrowswithhook hook yields hook' yields hookrightarrow yields. Lee, In response to “our internal feature request list”, I offer the following user story. As a professional software developer, I would like more transparency into the GitHub feature request process, and the opportunity to contribute open source soultions to address such feature requests. Command above generates files into the dist folder and publishes them to npmjs.org. 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. Workflow Diagrams. Train new employees or show business operations with a step-by-step walkthrough of a workflow. Swimlane Diagrams. Capture how teams or processes work in tandem by splitting tasks across the lanes of a swimlane flowchart. Data Flowcharts. AKA 'Data Flow Diagrams' show how information moves throughout a system. Flowchart Types.

Mermaid simplifies complex diagrams. It is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically. 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.
Mermaid addresses this Catch-22 by cutting the time, effort and tooling that is required to create modifiable diagrams and charts, for smarter and more reusable content. Mermaid, as a text-based diagramming tool allows for quick and easy updates, it can also be made part of production scripts (and other pieces of code), to make documentation much easier. With Mermaid less time needs to be spent on making diagrams, as a separate documentation task.

Mermaid is a Diagramming tool for everyone.

Even non-programmers can create diagrams through the Mermaid Live Editor, Visit the Tutorials Page for the Live Editor video tutorials.

Want to see what can be built with mermaid, or what applications already support it? Read the Integrations and Usages for Mermaid.

For a more detailed introduction to Mermaid and some of it's more basic uses, look to the Beginner's Guide and Usage.

🖖 Keep a steady pulse: mermaid needs more Collaborators, Read More.

Flowchart

Sequence diagram

Gantt diagram

Class diagram - experimental

Git graph - experimental

Entity Relationship Diagram - experimental

User Journey Diagram

In depth guides and examples can be found in Getting Started and Usage.

It would also be helpful to learn more about mermaid's Syntax.

CDN

To select a version:

Replace <version> with the desired version number.

Alternatively, you can also adjust the version number in the page itself.

Latest Version: https://unpkg.com/browse/mermaid@8.8.0/

Incorporating mermaid to a website

To support mermaid on your website, all you have to do is add Mermaid's JavaScript package

To deploy mermaid without a bundler, one can insert a script tag with an absolute address and a mermaidAPI call into the HTML like so:

Doing so will command the mermaid parser to look for the <div> tags with class='mermaid' in your HTML Document. From these tags mermaid will try to read the diagram/chart definitons and render them as svg charts.

Examples can be found in Getting Started

Request for Assistance

Things are piling up and I have a 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 of 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:

• Adding more types of diagrams like mindmaps, ert diagrams, etc.
• Improving existing diagrams

Don't hesitate to contact me if you want to get involved!

For contributors

Setup

Build

Lint

We use eslint. We recommend you installing editor plugins so you can get real time lint result.

Test

Manual test in browser: open dist/index.html

Typora Flowchart

Release

For those who have the permission to do so:

Update version number in package.json.

Command above generates files into the dist folder and publishes them to npmjs.org.

Credits

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.

Typora Graph

Mermaid was created by Knut Sveidqvist for easier documentation.

Typography Diagrams

Tyler Long has became a collaborator since April 2017.

Here is the full list of the projects contributors.