mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-01-28 07:03:17 +08:00
304 lines
12 KiB
Markdown
304 lines
12 KiB
Markdown
# About Mermaid
|
|
|
|
**Mermaid lets you create diagrams and visualizations using text and code.**
|
|
|
|
It is a Javascript based diagramming and charting tool that renders Markdown-inspired text definitions to create and modify diagrams dynamically.
|
|
|
|
>If you are familiar with Markdown you should have no problem learning [Mermaid's Syntax](./n00b-syntaxReference.md).
|
|
|
|
|
|
|
|
|
|
<!-- **Edit this Page** [](https://github.com/mermaid-js/mermaid/blob/develop/docs/README.md) -->
|
|
|
|
[](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)
|
|
|
|
<!-- Mermaidn book banner -->
|
|
[](https://mermaid-js.github.io/mermaid/landing/)
|
|
|
|
|
|
<!-- <Main description> -->
|
|
The main purpose of Mermaid is to help with Visualizing Documentation, and helping it catch up with Development.
|
|
> Documentation-Rot is a Catch-22 that Mermaid helps to solve.
|
|
|
|
Diagramming and Documentation cost precious developer time and get outdated quickly.
|
|
However, not having diagrams or documentation ruins productivity and hampers organizational learning.
|
|
|
|
Mermaid addresses this Catch-22 situation by reducing the time, effort and tooling that is required to create modifiable diagrams and charts which in turn results in smarter and more reusable content.
|
|
Mermaid, as a text-based diagramming tool allows for quick and easy updates and makes documentation much easier. It can also be included in production scripts and other pieces of code as per requirement.
|
|
|
|
> Mermaid is a Diagramming tool for everyone.
|
|
|
|
Even non-programmers can create diagrams through the [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor), Visit the [Tutorials Page](./Tutorials.md) for the Live Editor video tutorials.
|
|
|
|
Many editors, wikis and other tools also have mermaid integrations and plugins, making it easy to start using mermaid. A few of those are described in [Simple start to write diagrams](./n00b-gettingStarted.md).
|
|
|
|
For a more detailed introduction to Mermaid and some of it's basic uses, refer to [Overview for Beginners](./n00b-overview.md) and [Usage](./usage.md).
|
|
|
|
🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/docs/development.md) | 📜 [Version Log](./CHANGELOG.md) | 🔌 [Plug-Ins](./integrations.md)
|
|
|
|
> 🖖 Keep a steady pulse: mermaid needs more Collaborators, [Read More](https://github.com/knsv/mermaid/issues/866).
|
|
|
|
:trophy: **Mermaid was nominated and won the [JS Open Source Awards (2019)](https://osawards.com/javascript/#nominees) 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 🙏**
|
|
|
|
|
|
# Diagram Types
|
|
|
|
### [Flowchart](./flowchart.md?id=flowcharts-basic-syntax)
|
|
|
|
```mmd
|
|
graph TD;
|
|
A-->B;
|
|
A-->C;
|
|
B-->D;
|
|
C-->D;
|
|
```
|
|
|
|
|
|
|
|
### [Sequence diagram](./sequenceDiagram.md)
|
|
|
|
```mmd
|
|
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!
|
|
```
|
|
|
|
|
|
|
|
### [Gantt diagram](./gantt.md)
|
|
|
|
```mmd
|
|
gantt
|
|
dateFormat YYYY-MM-DD
|
|
title Adding GANTT diagram to mermaid
|
|
excludes weekdays 2014-01-10
|
|
|
|
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
|
|
```
|
|
|
|
|
|
|
|
### [Class diagram](./classDiagram.md)
|
|
|
|
```mmd
|
|
classDiagram
|
|
Class01 <|-- AveryLongClass : Cool
|
|
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
|
|
```
|
|
|
|
|
|
|
|
### Git graph - :exclamation: experimental
|
|
|
|
```mmd
|
|
gitGraph:
|
|
options
|
|
{
|
|
"nodeSpacing": 150,
|
|
"nodeRadius": 10
|
|
}
|
|
end
|
|
commit
|
|
branch newbranch
|
|
checkout newbranch
|
|
commit
|
|
commit
|
|
checkout master
|
|
commit
|
|
commit
|
|
merge newbranch
|
|
|
|
```
|
|
|
|
|
|
### [Entity Relationship Diagram - :exclamation: experimental](./entityRelationshipDiagram.md)
|
|
|
|
```mmd
|
|
erDiagram
|
|
CUSTOMER ||--o{ ORDER : places
|
|
ORDER ||--|{ LINE-ITEM : contains
|
|
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
|
|
|
|
```
|
|
|
|
|
|
|
|
### [User Journey Diagram](./user-journey.md)
|
|
|
|
```mmd
|
|
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: 5: Me
|
|
```
|
|
|
|
|
|
# Installation
|
|
|
|
**In depth guides and examples can be found at [Getting Started](/n00b-gettingStarted) and [Usage](/usage).**
|
|
|
|
**It would also be helpful to learn more about mermaid's [Syntax](/n00b-syntaxReference).**
|
|
|
|
### CDN
|
|
|
|
```
|
|
https://unpkg.com/mermaid@<version>/dist/
|
|
```
|
|
|
|
To select a version:
|
|
|
|
Replace `<version>` with the desired version number.
|
|
|
|
Latest Version: [https://unpkg.com/browse/mermaid@8.8.0/](https://unpkg.com/browse/mermaid@8.8.0/)
|
|
|
|
## Deploying Mermaid
|
|
To Deploy Mermaid:
|
|
|
|
1. You will need to install node v16, which would have npm
|
|
2. Download yarn using npm
|
|
3. Enter the following command: `yarn add mermaid`
|
|
4. You can then add mermaid as a dev dependency using this command:
|
|
`yarn add --dev mermaid`
|
|
|
|
## [Mermaid API](./Setup.md):
|
|
|
|
**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:**
|
|
|
|
```html
|
|
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
|
|
<script>mermaid.initialize({startOnLoad:true});
|
|
</script>
|
|
```
|
|
**Doing so will command the mermaid parser to look for the `<div>` tags with `class="mermaid"`. From these tags mermaid will try to read the diagram/chart definitions and render them into svg charts.**
|
|
|
|
**Examples can be found at** [Other examples](/examples)
|
|
|
|
# Sibling projects
|
|
|
|
- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
|
|
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
|
|
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
|
|
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
|
|
|
|
## Request for Assistance
|
|
|
|
Things are piling up and I have a hard time keeping up. 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
|
|
|
|
```sh
|
|
yarn install
|
|
```
|
|
|
|
### Build
|
|
|
|
```sh
|
|
yarn build:watch
|
|
```
|
|
|
|
### Lint
|
|
|
|
```sh
|
|
yarn lint
|
|
```
|
|
|
|
We use [eslint](https://eslint.org/).
|
|
We recommend you to install [editor plugins](https://eslint.org/docs/user-guide/integrations) to get real time lint result.
|
|
|
|
### Test
|
|
|
|
```sh
|
|
yarn test
|
|
```
|
|
Manual test in browser: open `dist/index.html`
|
|
|
|
### Release
|
|
|
|
For those who have the permission to do so:
|
|
|
|
Update version number in `package.json`.
|
|
|
|
```sh
|
|
npm publish
|
|
```
|
|
|
|
The above command generates files into the `dist` folder and publishes them to npmjs.org.
|
|
|
|
## 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%22Good+first+issue%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)
|
|
|
|
## Security and safe diagrams
|
|
|
|
For public sites, it can be precarious to retrieve text from users on the internet, storing that content for presentation in a browser at a later stage. The reason is that the user content can contain embedded malicious scripts that will run when the data is presented. For Mermaid this is a risk, specially as mermaid diagrams contain many characters that are used in html which makes the standard sanitation unusable as it also breaks the diagrams. We still make an effort to sanitise the incoming code and keep refining the process but it is hard to guarantee that there are no loop holes.
|
|
|
|
As an extra level of security for sites with external users we are happy to introduce a new security level in which the diagram is rendered in a sandboxed iframe preventing javascript in the code from being executed. This is a great step forward for better security.
|
|
|
|
*Unfortunately you can not have a cake and eat it at the same time which in this case means that some of the interactive functionality gets blocked along with the possible malicious code.*
|
|
|
|
## Reporting vulnerabilities
|
|
To report a vulnerability, please e-mail security@mermaid.live with a description of the issue, the steps you took to create the issue, affected versions, and if known, mitigations for the issue.
|
|
|
|
## Appreciation
|
|
A quick note from Knut Sveidqvist:
|
|
>*Many thanks to the [d3](https://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](https://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.* |