GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-28 07:03:17 +08:00
Code Issues Projects Releases Wiki Activity

Prettier

Browse Source
This commit is contained in:
Sidharth Vinod 2022-09-03 13:30:16 +05:30
parent 661f283dab
commit f6d69b33b3
No known key found for this signature in database
GPG Key ID: FB5CCD378D3907CD
78 changed files with 7227 additions and 2379 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
__mocks__/d3.js vendored
View File

@ -1,4 +1,7 @@
let NewD3 = function () { let NewD3 = function () {
/**
*
*/
function returnThis() { function returnThis() {
return this; return this;
} }

1080
docs/CHANGELOG.md
View File

File diff suppressed because it is too large Load Diff

20
docs/README.md
View File

@ -204,7 +204,7 @@ To Deploy Mermaid:
```html ```html
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
``` ```
@ -214,10 +214,10 @@ To Deploy Mermaid:
## Sibling projects ## Sibling projects
- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) - [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) - [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) - [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) - [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
## Request for Assistance ## Request for Assistance
@ -229,8 +229,8 @@ represent the project when answering questions and issues.
Together we could continue the work with things like: Together we could continue the work with things like:
- Adding more types of diagrams like mindmaps, ert diagrams, etc. - Adding more types of diagrams like mindmaps, ert diagrams, etc.
- Improving existing diagrams - Improving existing diagrams
Don't hesitate to contact me if you want to get involved! Don't hesitate to contact me if you want to get involved!
@ -279,9 +279,9 @@ The above command generates files into the `dist` folder and publishes them to n
## Related projects ## Related projects
- [Command Line Interface](https://github.com/mermaid-js/mermaid-cli) - [Command Line Interface](https://github.com/mermaid-js/mermaid-cli)
- [Live Editor](https://github.com/mermaid-js/mermaid-live-editor) - [Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
- [HTTP Server](https://github.com/TomWright/mermaid-server) - [HTTP Server](https://github.com/TomWright/mermaid-server)
## Contributors [![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) ## Contributors [![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)

26
docs/SUMMARY.md
View File

@ -2,16 +2,16 @@
# Summary # Summary
- [mermaid](README.md) - [mermaid](README.md)
- [FAQ](faq.md) - [FAQ](faq.md)
- [Breaking changes](breakingChanges.md) - [Breaking changes](breakingChanges.md)
- [Usage](usage.md) - [Usage](usage.md)
- [Flowchart](flowchart.md) - [Flowchart](flowchart.md)
- [Sequence diagram](sequenceDiagram.md) - [Sequence diagram](sequenceDiagram.md)
- [Gantt diagram](gantt.md) - [Gantt diagram](gantt.md)
- [mermaid CLI](mermaidCLI.md) - [mermaid CLI](mermaidCLI.md)
- [Demos](demos.md) - [Demos](demos.md)
- [mermaidAPI](mermaidAPI.md) - [mermaidAPI](mermaidAPI.md)
- [Development](development.md) - [Development](development.md)
- [Upgrading](upgrading.md) - [Upgrading](upgrading.md)
- [Contribute to this website](https://github.com/mermaidjs/mermaid-gitbook) - [Contribute to this website](https://github.com/mermaidjs/mermaid-gitbook)

170
docs/Setup.md
View File

@ -66,12 +66,12 @@ Theme , the CSS style sheet
**Notes:** **Notes:**
- Trace: 0 - Trace: 0
- Debug: 1 - Debug: 1
- Info: 2 - Info: 2
- Warn: 3 - Warn: 3
- Error: 4 - Error: 4
- Fatal: 5 (default) - Fatal: 5 (default)
## securityLevel ## securityLevel
@ -81,13 +81,13 @@ Theme , the CSS style sheet
**Notes**: **Notes**:
- **strict**: (**default**) tags in text are encoded, click functionality is disabled - **strict**: (**default**) tags in text are encoded, click functionality is disabled
- **loose**: tags in text are allowed, click functionality is enabled - **loose**: tags in text are allowed, click functionality is enabled
- **antiscript**: html tags in text are allowed, (only script element is removed), click - **antiscript**: html tags in text are allowed, (only script element is removed), click
functionality is enabled functionality is enabled
- **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This - **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This
prevent any JavaScript from running in the context. This may hinder interactive functionality prevent any JavaScript from running in the context. This may hinder interactive functionality
of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc.
## startOnLoad ## startOnLoad
@ -1422,7 +1422,7 @@ function _Default value: At default, will mirror Global Config_
### Parameters ### Parameters
- `conf` **MermaidConfig** The base currentConfig to use as siteConfig - `conf` **MermaidConfig** The base currentConfig to use as siteConfig
Returns **[object][5]** The siteConfig Returns **[object][5]** The siteConfig
@ -1452,7 +1452,7 @@ corresponding siteConfig value.
### Parameters ### Parameters
- `conf` **any** The potential currentConfig - `conf` **any** The potential currentConfig
Returns **any** The currentConfig merged with the sanitized conf Returns **any** The currentConfig merged with the sanitized conf
@ -1462,25 +1462,25 @@ Function that renders an svg with a graph from a chart definition. Usage example
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
startOnLoad: true, startOnLoad: true,
}); });
$(function () { $(function () {
const graphDefinition = 'graph TB\na-->b'; const graphDefinition = 'graph TB\na-->b';
const cb = function (svgGraph) { const cb = function (svgGraph) {
console.log(svgGraph); console.log(svgGraph);
}; };
mermaidAPI.render('id1', graphDefinition, cb); mermaidAPI.render('id1', graphDefinition, cb);
}); });
``` ```
### Parameters ### Parameters
- `id` **[string][6]** The id of the element to be rendered - `id` **[string][6]** The id of the element to be rendered
- `text` **[string][6]** The graph definition - `text` **[string][6]** The graph definition
- `cb` **function (svgCode: [string][6], bindFunctions: function (element: [Element][7]): void): void** - `cb` **function (svgCode: [string][6], bindFunctions: function (element: [Element][7]): void): void**
- `container` **[Element][7]** Selector to element in which a div with the graph temporarily will be - `container` **[Element][7]** Selector to element in which a div with the graph temporarily will be
inserted. If one is provided a hidden div will be inserted in the body of the page instead. The inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
element will be removed when rendering is completed. element will be removed when rendering is completed.
Returns **void** Returns **void**
@ -1509,7 +1509,7 @@ options in-place
### Parameters ### Parameters
- `options` **any** The potential setConfig parameter - `options` **any** The potential setConfig parameter
## addDirective ## addDirective
@ -1517,7 +1517,7 @@ Pushes in a directive to the configuration
### Parameters ### Parameters
- `directive` **[object][5]** The directive to push in - `directive` **[object][5]** The directive to push in
## reset ## reset
@ -1537,7 +1537,7 @@ Pushes in a directive to the configuration
### Parameters ### Parameters
- `config` (optional, default `siteConfig`) - `config` (optional, default `siteConfig`)
Returns **void** Returns **void**
@ -1545,7 +1545,7 @@ Returns **void**
### Parameters ### Parameters
- `options` **MermaidConfig** - `options` **MermaidConfig**
## ##
@ -1553,61 +1553,61 @@ Returns **void**
```html ```html
<script> <script>
var config = { var config = {
theme: 'default', theme: 'default',
logLevel: 'fatal', logLevel: 'fatal',
securityLevel: 'strict', securityLevel: 'strict',
startOnLoad: true, startOnLoad: true,
arrowMarkerAbsolute: false, arrowMarkerAbsolute: false,
er: { er: {
diagramPadding: 20, diagramPadding: 20,
layoutDirection: 'TB', layoutDirection: 'TB',
minEntityWidth: 100, minEntityWidth: 100,
minEntityHeight: 75, minEntityHeight: 75,
entityPadding: 15, entityPadding: 15,
stroke: 'gray', stroke: 'gray',
fill: 'honeydew', fill: 'honeydew',
fontSize: 12, fontSize: 12,
useMaxWidth: true, useMaxWidth: true,
}, },
flowchart: { flowchart: {
diagramPadding: 8, diagramPadding: 8,
htmlLabels: true, htmlLabels: true,
curve: 'basis', curve: 'basis',
}, },
sequence: { sequence: {
diagramMarginX: 50, diagramMarginX: 50,
diagramMarginY: 10, diagramMarginY: 10,
actorMargin: 50, actorMargin: 50,
width: 150, width: 150,
height: 65, height: 65,
boxMargin: 10, boxMargin: 10,
boxTextMargin: 5, boxTextMargin: 5,
noteMargin: 10, noteMargin: 10,
messageMargin: 35, messageMargin: 35,
messageAlign: 'center', messageAlign: 'center',
mirrorActors: true, mirrorActors: true,
bottomMarginAdj: 1, bottomMarginAdj: 1,
useMaxWidth: true, useMaxWidth: true,
rightAngles: false, rightAngles: false,
showSequenceNumbers: false, showSequenceNumbers: false,
}, },
gantt: { gantt: {
titleTopMargin: 25, titleTopMargin: 25,
barHeight: 20, barHeight: 20,
barGap: 4, barGap: 4,
topPadding: 50, topPadding: 50,
leftPadding: 75, leftPadding: 75,
gridLineStartPadding: 35, gridLineStartPadding: 35,
fontSize: 11, fontSize: 11,
fontFamily: '"Open Sans", sans-serif', fontFamily: '"Open Sans", sans-serif',
numberSectionStyles: 4, numberSectionStyles: 4,
axisFormat: '%Y-%m-%d', axisFormat: '%Y-%m-%d',
topAxis: false, topAxis: false,
}, },
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
``` ```

22
docs/_navbar.md
View File

@ -1,15 +1,15 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs.
- Getting started - Getting started
- [Quick start](quickstart.md) - [Quick start](quickstart.md)
- [Writing more pages](more-pages.md) - [Writing more pages](more-pages.md)
- [Custom navbar](custom-navbar.md) - [Custom navbar](custom-navbar.md)
- [Cover page](cover.md) - [Cover page](cover.md)
- Configuration - Configuration
- [Configuration](configuration.md) - [Configuration](configuration.md)
- [Themes](themes.md) - [Themes](themes.md)
- [Using plugins](plugins.md) - [Using plugins](plugins.md)
- [Markdown configuration](markdown.md) - [Markdown configuration](markdown.md)
- [Language highlight](language-highlight.md) - [Language highlight](language-highlight.md)

70
docs/_sidebar.md
View File

@ -1,45 +1,45 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs.
- 📔 Introduction - 📔 Introduction
- [About Mermaid](README.md) - [About Mermaid](README.md)
- [Deployment](n00b-gettingStarted.md) - [Deployment](n00b-gettingStarted.md)
- [Syntax and Configuration](n00b-syntaxReference.md) - [Syntax and Configuration](n00b-syntaxReference.md)
- 📊 Diagram Syntax - 📊 Diagram Syntax
- [Flowchart](flowchart.md) - [Flowchart](flowchart.md)
- [Sequence Diagram](sequenceDiagram.md) - [Sequence Diagram](sequenceDiagram.md)
- [Class Diagram](classDiagram.md) - [Class Diagram](classDiagram.md)
- [State Diagram](stateDiagram.md) - [State Diagram](stateDiagram.md)
- [Entity Relationship Diagram](entityRelationshipDiagram.md) - [Entity Relationship Diagram](entityRelationshipDiagram.md)
- [User Journey](user-journey.md) - [User Journey](user-journey.md)
- [Gantt](gantt.md) - [Gantt](gantt.md)
- [Pie Chart](pie.md) - [Pie Chart](pie.md)
- [Requirement Diagram](requirementDiagram.md) - [Requirement Diagram](requirementDiagram.md)
- [Gitgraph (Git) Diagram 🔥](gitgraph.md) - [Gitgraph (Git) Diagram 🔥](gitgraph.md)
- [C4C Diagram (Context) Diagram 🦺⚠️](c4c.md) - [C4C Diagram (Context) Diagram 🦺⚠️](c4c.md)
- [Other Examples](examples.md) - [Other Examples](examples.md)
- ⚙️ Deployment and Configuration - ⚙️ Deployment and Configuration
- [Tutorials](Tutorials.md) - [Tutorials](Tutorials.md)
- [API-Usage](usage.md) - [API-Usage](usage.md)
- [Mermaid API Configuration](Setup.md) - [Mermaid API Configuration](Setup.md)
- [Directives](directives.md) - [Directives](directives.md)
- [Theming](theming.md) - [Theming](theming.md)
- [Accessibility](accessibility.md) - [Accessibility](accessibility.md)
- [Mermaid CLI](mermaidCLI.md) - [Mermaid CLI](mermaidCLI.md)
- [Advanced usage](n00b-advanced.md) - [Advanced usage](n00b-advanced.md)
- 📚 Misc - 📚 Misc
- [Use-Cases and Integrations](integrations.md) - [Use-Cases and Integrations](integrations.md)
- [FAQ](faq.md) - [FAQ](faq.md)
- 🙌 Contributions and Community - 🙌 Contributions and Community
- [Overview for Beginners](n00b-overview.md) - [Overview for Beginners](n00b-overview.md)
- [Development and Contribution ](development.md) - [Development and Contribution ](development.md)
- [Changelog](CHANGELOG.md) - [Changelog](CHANGELOG.md)
- [Adding Diagrams ](newDiagram.md) - [Adding Diagrams ](newDiagram.md)
- [Security ](security.md) - [Security ](security.md)

4
docs/accessibility.md
View File

@ -16,8 +16,8 @@ This support for accessibility options is available for all the diagrams/chart t
The diagram authors can now add the accessibility options in the diagram definition, using the `accTitle` and `accDescr` keywords, where each keyword is followed by `:` and the string value for title and description like: The diagram authors can now add the accessibility options in the diagram definition, using the `accTitle` and `accDescr` keywords, where each keyword is followed by `:` and the string value for title and description like:
- `accTitle: "Your Accessibility Title"` or - `accTitle: "Your Accessibility Title"` or
- `accDescr: "Your Accessibility Description"` - `accDescr: "Your Accessibility Description"`
**When these two options are defined, they will add a coressponding `<title>` and `<desc>` tag in the SVG.** **When these two options are defined, they will add a coressponding `<title>` and `<desc>` tag in the SVG.**

2
docs/breakingChanges.md
View File

@ -44,7 +44,7 @@ You just:
```javascript ```javascript
mermaid.initialize({ mermaid.initialize({
theme: 'forest', theme: 'forest',
}); });
``` ```

136
docs/c4c.md
View File

@ -104,11 +104,11 @@ For an example, see the source code demos/index.html
5 types of C4 charts are supported. 5 types of C4 charts are supported.
- System Context (C4Context) - System Context (C4Context)
- Container diagram (C4Container) - Container diagram (C4Container)
- Component diagram (C4Component) - Component diagram (C4Component)
- Dynamic diagram (C4Dynamic) - Dynamic diagram (C4Dynamic)
- Deployment diagram (C4Deployment) - Deployment diagram (C4Deployment)
Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram. Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram.
@ -118,129 +118,129 @@ updateElementStyle and UpdateElementStyle are written in the diagram last part.
The layout does not use a fully automated layout algorithm. The position of shapes is adjusted by changing the order in which statements are written. So there is no plan to support the following Layout statements. The layout does not use a fully automated layout algorithm. The position of shapes is adjusted by changing the order in which statements are written. So there is no plan to support the following Layout statements.
The number of shapes per row and the number of boundaries can be adjusted using UpdateLayoutConfig. The number of shapes per row and the number of boundaries can be adjusted using UpdateLayoutConfig.
- Layout - Layout
- - Lay_U, Lay_Up - - Lay_U, Lay_Up
- - Lay_D, Lay_Down - - Lay_D, Lay_Down
- - Lay_L, Lay_Left - - Lay_L, Lay_Left
- - Lay_R, Lay_Right - - Lay_R, Lay_Right
The following unfinished features are not supported in the short term. The following unfinished features are not supported in the short term.
- \[ ] sprite - \[ ] sprite
- \[ ] tags - \[ ] tags
- \[ ] link - \[ ] link
- \[ ] Legend - \[ ] Legend
- \[x] System Context - \[x] System Context
- - \[x] Person(alias, label, ?descr, ?sprite, ?tags, $link) - - \[x] Person(alias, label, ?descr, ?sprite, ?tags, $link)
- - \[x] Person_Ext - - \[x] Person_Ext
- - \[x] System(alias, label, ?descr, ?sprite, ?tags, $link) - - \[x] System(alias, label, ?descr, ?sprite, ?tags, $link)
- - \[x] SystemDb - - \[x] SystemDb
- - \[x] SystemQueue - - \[x] SystemQueue
- - \[x] System_Ext - - \[x] System_Ext
- - \[x] SystemDb_Ext - - \[x] SystemDb_Ext
- - \[x] SystemQueue_Ext - - \[x] SystemQueue_Ext
- - \[x] Boundary(alias, label, ?type, ?tags, $link) - - \[x] Boundary(alias, label, ?type, ?tags, $link)
- - \[x] Enterprise_Boundary(alias, label, ?tags, $link) - - \[x] Enterprise_Boundary(alias, label, ?tags, $link)
- - \[x] System_Boundary - - \[x] System_Boundary
- \[x] Container diagram - \[x] Container diagram
- - \[x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - - \[x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link)
- - \[x] ContainerDb - - \[x] ContainerDb
- - \[x] ContainerQueue - - \[x] ContainerQueue
- - \[x] Container_Ext - - \[x] Container_Ext
- - \[x] ContainerDb_Ext - - \[x] ContainerDb_Ext
- - \[x] ContainerQueue_Ext - - \[x] ContainerQueue_Ext
- - \[x] Container_Boundary(alias, label, ?tags, $link) - - \[x] Container_Boundary(alias, label, ?tags, $link)
- \[x] Component diagram - \[x] Component diagram
- - \[x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - - \[x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link)
- - \[x] ComponentDb - - \[x] ComponentDb
- - \[x] ComponentQueue - - \[x] ComponentQueue
- - \[x] Component_Ext - - \[x] Component_Ext
- - \[x] ComponentDb_Ext - - \[x] ComponentDb_Ext
- - \[x] ComponentQueue_Ext - - \[x] ComponentQueue_Ext
- \[x] Dynamic diagram - \[x] Dynamic diagram
- - \[x] RelIndex(index, from, to, label, ?tags, $link) - - \[x] RelIndex(index, from, to, label, ?tags, $link)
- \[x] Deployment diagram - \[x] Deployment diagram
- - \[x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link) - - \[x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link)
- - \[x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node() - - \[x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node()
- - \[x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node() - - \[x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node()
- - \[x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node() - - \[x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node()
- \[x] Relationship Types - \[x] Relationship Types
- - \[x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link) - - \[x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link)
- - \[x] BiRel (bidirectional relationship) - - \[x] BiRel (bidirectional relationship)
- - \[x] Rel_U, Rel_Up - - \[x] Rel_U, Rel_Up
- - \[x] Rel_D, Rel_Down - - \[x] Rel_D, Rel_Down
- - \[x] Rel_L, Rel_Left - - \[x] Rel_L, Rel_Left
- - \[x] Rel_R, Rel_Right - - \[x] Rel_R, Rel_Right
- - \[x] Rel_Back - - \[x] Rel_Back
- - \[x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written. - - \[x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written.
- \[ ] Custom tags/stereotypes support and skinparam updates - \[ ] Custom tags/stereotypes support and skinparam updates
- - \[ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend. - - \[ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend.
- - \[ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend. - - \[ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend.
- - \[x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry. - - \[x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry.
- - \[x] UpdateRelStyle(from, to, ?textColor, ?lineColor, ?offsetX, ?offsetY): This call updates the default relationship colors and creates no additional legend entry. Two new parameters, offsetX and offsetY, are added to set the offset of the original position of the text. - - \[x] UpdateRelStyle(from, to, ?textColor, ?lineColor, ?offsetX, ?offsetY): This call updates the default relationship colors and creates no additional legend entry. Two new parameters, offsetX and offsetY, are added to set the offset of the original position of the text.
- - \[ ] RoundedBoxShape(): This call returns the name of the rounded box shape and can be used as ?shape argument. - - \[ ] RoundedBoxShape(): This call returns the name of the rounded box shape and can be used as ?shape argument.
- - \[ ] EightSidedShape(): This call returns the name of the eight sided shape and can be used as ?shape argument. - - \[ ] EightSidedShape(): This call returns the name of the eight sided shape and can be used as ?shape argument.
- - \[ ] DashedLine(): This call returns the name of the dashed line and can be used as ?lineStyle argument. - - \[ ] DashedLine(): This call returns the name of the dashed line and can be used as ?lineStyle argument.
- - \[ ] DottedLine(): This call returns the name of the dotted line and can be used as ?lineStyle argument. - - \[ ] DottedLine(): This call returns the name of the dotted line and can be used as ?lineStyle argument.
- - \[ ] BoldLine(): This call returns the name of the bold line and can be used as ?lineStyle argument. - - \[ ] BoldLine(): This call returns the name of the bold line and can be used as ?lineStyle argument.
- - \[x] UpdateLayoutConfig(?c4ShapeInRow, ?c4BoundaryInRow): New. This call updates the default c4ShapeInRow(4) and c4BoundaryInRow(2). - - \[x] UpdateLayoutConfig(?c4ShapeInRow, ?c4BoundaryInRow): New. This call updates the default c4ShapeInRow(4) and c4BoundaryInRow(2).
There are two ways to assign parameters with question marks. One uses the non-named parameter assignment method in the order of the parameters, and the other uses the named parameter assignment method, where the name must start with a $ symbol. There are two ways to assign parameters with question marks. One uses the non-named parameter assignment method in the order of the parameters, and the other uses the named parameter assignment method, where the name must start with a $ symbol.

184
docs/classDiagram.md
View File

@ -64,9 +64,9 @@ classDiagram
UML provides mechanisms to represent class members, such as attributes and methods, and additional information about them. UML provides mechanisms to represent class members, such as attributes and methods, and additional information about them.
A single instance of a class in the diagram contains three compartments: A single instance of a class in the diagram contains three compartments:
- The top compartment contains the name of the class. It is printed in bold and centered, and the first letter is capitalized. It may also contain optional annotation text describing the nature of the class. - The top compartment contains the name of the class. It is printed in bold and centered, and the first letter is capitalized. It may also contain optional annotation text describing the nature of the class.
- The middle compartment contains the attributes of the class. They are left-aligned and the first letter is lowercase. - The middle compartment contains the attributes of the class. They are left-aligned and the first letter is lowercase.
- The bottom compartment contains the operations the class can execute. They are also left-aligned and the first letter is lowercase. - The bottom compartment contains the operations the class can execute. They are also left-aligned and the first letter is lowercase.
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -92,8 +92,8 @@ classDiagram
There are two ways to define a class: There are two ways to define a class:
- Explicitly using keyword **class** like `class Animal` which would define the Animal class. - Explicitly using keyword **class** like `class Animal` which would define the Animal class.
- Via a **relationship** which defines two classes at a time along with their relationship. For instance, `Vehicle <|-- Car`. - Via a **relationship** which defines two classes at a time along with their relationship. For instance, `Vehicle <|-- Car`.
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -117,7 +117,7 @@ Mermaid distinguishes between attributes and functions/methods based on if the *
There are two ways to define the members of a class, and regardless of whichever syntax is used to define the members, the output will still be same. The two different ways are : There are two ways to define the members of a class, and regardless of whichever syntax is used to define the members, the output will still be same. The two different ways are :
- Associate a member of a class using **:** (colon) followed by member name, useful to define one member at a time. For example: - Associate a member of a class using **:** (colon) followed by member name, useful to define one member at a time. For example:
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -137,7 +137,7 @@ BankAccount : +deposit(amount)
BankAccount : +withdrawal(amount) BankAccount : +withdrawal(amount)
``` ```
- Associate members of a class using **{}** brackets, where members are grouped within curly brackets. Suitable for defining multiple members at once. For example: - Associate members of a class using **{}** brackets, where members are grouped within curly brackets. Suitable for defining multiple members at once. For example:
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -225,19 +225,19 @@ Optionally you can end the method/function definition with the data type that wi
To describe the visibility (or encapsulation) of an attribute or method/function that is a part of a class (i.e. a class member), optional notation may be placed before that members' name: To describe the visibility (or encapsulation) of an attribute or method/function that is a part of a class (i.e. a class member), optional notation may be placed before that members' name:
- `+` Public - `+` Public
- `-` Private - `-` Private
- `#` Protected - `#` Protected
- `~` Package/Internal - `~` Package/Internal
> _note_ you can also include additional _classifiers_ to a method definition by adding the following notation to the _end_ of the method, i.e.: after the `()`: > _note_ you can also include additional _classifiers_ to a method definition by adding the following notation to the _end_ of the method, i.e.: after the `()`:
> >
> - `*` Abstract e.g.: `someAbstractMethod()*` > - `*` Abstract e.g.: `someAbstractMethod()*`
> - `$` Static e.g.: `someStaticMethod()$` > - `$` Static e.g.: `someStaticMethod()$`
> _note_ you can also include additional _classifiers_ to a field definition by adding the following notation to the end of its name: > _note_ you can also include additional _classifiers_ to a field definition by adding the following notation to the end of its name:
> >
> - `$` Static e.g.: `String someField$` > - `$` Static e.g.: `String someField$`
## Defining Relationship ## Defining Relationship
@ -371,13 +371,13 @@ Multiplicity notations are placed near the end of an association.
The different cardinality options are : The different cardinality options are :
- `1` Only 1 - `1` Only 1
- `0..1` Zero or One - `0..1` Zero or One
- `1..*` One or more - `1..*` One or more
- `*` Many - `*` Many
- `n` n {where n>1} - `n` n {where n>1}
- `0..n` zero to n {where n>1} - `0..n` zero to n {where n>1}
- `1..n` one to n {where n>1} - `1..n` one to n {where n>1}
Cardinality can be easily defined by placing the text option within quotes `"` before or after a given arrow. For example: Cardinality can be easily defined by placing the text option within quotes `"` before or after a given arrow. For example:
@ -401,14 +401,14 @@ classDiagram
It is possible to annotate classes with markers to provide additional metadata about the class. This can give a clearer indication about its nature. Some common annotations include: It is possible to annotate classes with markers to provide additional metadata about the class. This can give a clearer indication about its nature. Some common annotations include:
- `<<Interface>>` To represent an Interface class - `<<Interface>>` To represent an Interface class
- `<<Abstract>>` To represent an abstract class - `<<Abstract>>` To represent an abstract class
- `<<Service>>` To represent a service class - `<<Service>>` To represent a service class
- `<<Enumeration>>` To represent an enum - `<<Enumeration>>` To represent an enum
Annotations are defined within the opening `<<` and closing `>>`. There are two ways to add an annotation to a class, and either way the output will be same: Annotations are defined within the opening `<<` and closing `>>`. There are two ways to add an annotation to a class, and either way the output will be same:
- In a **_separate line_** after a class is defined: - In a **_separate line_** after a class is defined:
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -426,7 +426,7 @@ Shape : noOfVertices
Shape : draw() Shape : draw()
``` ```
- In a **_nested structure_** along with the class definition: - In a **_nested structure_** along with the class definition:
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -528,11 +528,11 @@ You would define these actions on a separate line after all classes have been de
click className call callback() "tooltip" click className call callback() "tooltip"
click className href "url" "tooltip" click className href "url" "tooltip"
- _action_ is either `link` or `callback`, depending on which type of interaction you want to have called - _action_ is either `link` or `callback`, depending on which type of interaction you want to have called
- _className_ is the id of the node that the action will be associated with - _className_ is the id of the node that the action will be associated with
- _reference_ is either the url link, or the function name for callback. - _reference_ is either the url link, or the function name for callback.
- (_optional_) tooltip is a string to be displayed when hovering over element (note: The styles of the tooltip are set by the class .mermaidTooltip.) - (_optional_) tooltip is a string to be displayed when hovering over element (note: The styles of the tooltip are set by the class .mermaidTooltip.)
- note: callback function will be called with the nodeId as parameter. - note: callback function will be called with the nodeId as parameter.
### Examples ### Examples
@ -558,9 +558,9 @@ click Shape2 call callbackFunction() "This is a tooltip for a callback"
```html ```html
<script> <script>
var callbackFunction = function () { var callbackFunction = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
</script> </script>
``` ```
@ -594,23 +594,23 @@ Beginner's tip—a full example using interactive links in an HTML page:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
classDiagram Animal <|-- Duck Animal <|-- Fish Animal <|-- Zebra Animal : +int age Animal : classDiagram Animal <|-- Duck Animal <|-- Fish Animal <|-- Zebra Animal : +int age Animal :
+String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim() +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim()
+quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } callback
callback Duck callback "Tooltip" link Zebra "https://www.github.com" "This is a link" Duck callback "Tooltip" link Zebra "https://www.github.com" "This is a link"
</div> </div>
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
securityLevel: 'loose', securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
</body> </body>
``` ```
@ -622,11 +622,11 @@ It is possible to apply specific styles such as a thicker border or a different
```html ```html
<style> <style>
.cssClass > rect { .cssClass > rect {
fill: #ff0000; fill: #ff0000;
stroke: #ffff00; stroke: #ffff00;
stroke-width: 4px; stroke-width: 4px;
} }
</style> </style>
``` ```
@ -679,91 +679,91 @@ The main styling of the class diagram is done with a preset number of css classe
```scss ```scss
body { body {
background: white; background: white;
} }
g.classGroup text { g.classGroup text {
fill: $nodeBorder; fill: $nodeBorder;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
font-family: var(--mermaid-font-family); font-family: var(--mermaid-font-family);
font-size: 10px; font-size: 10px;
.title { .title {
font-weight: bolder; font-weight: bolder;
} }
} }
g.classGroup rect { g.classGroup rect {
fill: $nodeBkg; fill: $nodeBkg;
stroke: $nodeBorder; stroke: $nodeBorder;
} }
g.classGroup line { g.classGroup line {
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
} }
.classLabel .box { .classLabel .box {
stroke: none; stroke: none;
stroke-width: 0; stroke-width: 0;
fill: $nodeBkg; fill: $nodeBkg;
opacity: 0.5; opacity: 0.5;
} }
.classLabel .label { .classLabel .label {
fill: $nodeBorder; fill: $nodeBorder;
font-size: 10px; font-size: 10px;
} }
.relation { .relation {
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
fill: none; fill: none;
} }
@mixin composition { @mixin composition {
fill: $nodeBorder; fill: $nodeBorder;
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
} }
#compositionStart { #compositionStart {
@include composition; @include composition;
} }
#compositionEnd { #compositionEnd {
@include composition; @include composition;
} }
@mixin aggregation { @mixin aggregation {
fill: $nodeBkg; fill: $nodeBkg;
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
} }
#aggregationStart { #aggregationStart {
@include aggregation; @include aggregation;
} }
#aggregationEnd { #aggregationEnd {
@include aggregation; @include aggregation;
} }
#dependencyStart { #dependencyStart {
@include composition; @include composition;
} }
#dependencyEnd { #dependencyEnd {
@include composition; @include composition;
} }
#extensionStart { #extensionStart {
@include composition; @include composition;
} }
#extensionEnd { #extensionEnd {
@include composition; @include composition;
} }
``` ```

6
docs/developer-docs/configuration.md
View File

@ -4,9 +4,9 @@
When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration: When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration:
- The default configuration - The default configuration
- Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**. - Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**.
- Directives - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config. - Directives - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config.
**The render config** is configuration that is used when rendering by applying these configurations. **The render config** is configuration that is used when rendering by applying these configurations.

16
docs/development.md
View File

@ -26,9 +26,9 @@ This means that **you should branch off your pull request from develop** and dir
We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows: We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows:
- Large changes reviewed by knsv or other developer asked to review by knsv - Large changes reviewed by knsv or other developer asked to review by knsv
- Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators - Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators
- Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits) - Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits)
When you commit code, create a branch with the following naming convention: When you commit code, create a branch with the following naming convention:
@ -84,8 +84,8 @@ This is what a rendering test looks like:
```js ```js
it('should render forks and joins', () => { it('should render forks and joins', () => {
imgSnapshotTest( imgSnapshotTest(
` `
stateDiagram stateDiagram
state fork_state &lt;&lt;fork&gt;&gt; state fork_state &lt;&lt;fork&gt;&gt;
[*] --> fork_state [*] --> fork_state
@ -98,9 +98,9 @@ it('should render forks and joins', () => {
join_state --> State4 join_state --> State4
State4 --> [*] State4 --> [*]
`, `,
{ logLevel: 0 } { logLevel: 0 }
); );
cy.get('svg'); cy.get('svg');
}); });
``` ```

72
docs/diagrams-and-syntax-and-examples/flowchart.md
View File

@ -39,11 +39,11 @@ graph LR
Possible FlowChart orientations are: Possible FlowChart orientations are:
- TB - top to bottom - TB - top to bottom
- TD - top-down (same as top to bottom) - TD - top-down (same as top to bottom)
- BT - bottom to top - BT - bottom to top
- RL - right to left - RL - right to left
- LR - left to right - LR - left to right
## Flowcharts ## Flowcharts
@ -636,14 +636,14 @@ A node can have click events bound that lead to either a JavaScript callback or
click nodeId callback click nodeId callback
click nodeId call callback() click nodeId call callback()
- nodeId is the id of the node - nodeId is the id of the node
- `callback` is the name of a JavaScript function defined on the page displaying the graph. The function will be called with the nodeId as an incoming parameter. - `callback` is the name of a JavaScript function defined on the page displaying the graph. The function will be called with the nodeId as an incoming parameter.
```html ```html
<script> <script>
var callback = function (nodeId) { var callback = function (nodeId) {
alert('A callback was triggered on ' + nodeId); alert('A callback was triggered on ' + nodeId);
}; };
</script> </script>
``` ```
@ -707,27 +707,27 @@ Beginner's tip—here's a full example of using interactive links in HTML:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
graph LR; A-->B; B-->C; C-->D; click A callback "Tooltip" click B "https://www.github.com" graph LR; A-->B; B-->C; C-->D; click A callback "Tooltip" click B "https://www.github.com" "This
"This is a link" click C call callback() "Tooltip" click D href "https://www.github.com" is a link" click C call callback() "Tooltip" click D href "https://www.github.com" "This is a
"This is a link" link"
</div> </div>
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
flowchart: { flowchart: {
useMaxWidth: true, useMaxWidth: true,
htmlLabels: true, htmlLabels: true,
curve: 'cardinal', curve: 'cardinal',
}, },
securityLevel: 'loose', securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
</body> </body>
``` ```
@ -822,9 +822,9 @@ It is also possible to predefine classes in css styles that can be applied from
```css ```css
.cssClass > rect { .cssClass > rect {
fill: #ff0000; fill: #ff0000;
stroke: #ffff00; stroke: #ffff00;
stroke-width: 4px; stroke-width: 4px;
} }
``` ```
@ -872,9 +872,9 @@ graph TD
## Graph declarations with spaces between vertices and link and without semicolon ## Graph declarations with spaces between vertices and link and without semicolon
- After release 0.2.16, graph declaration statements do not need to end with a semicolon. (And they can continue to have the ending semicolon—it has now just become optional.) So the below graph declaration is valid along with the old declarations. - After release 0.2.16, graph declaration statements do not need to end with a semicolon. (And they can continue to have the ending semicolon—it has now just become optional.) So the below graph declaration is valid along with the old declarations.
- A single space is allowed between vertices and the link, however there should not be any space between a vertex and its text, or a link and its text. The old syntax of graph declarations will also work, so this new feature is optional and is introduced to improve readability. - A single space is allowed between vertices and the link, however there should not be any space between a vertex and its text, or a link and its text. The old syntax of graph declarations will also work, so this new feature is optional and is introduced to improve readability.
Below is an example of the new way to declare graph edges. This is valid alongside any old-style declarations of graph edges. Below is an example of the new way to declare graph edges. This is valid alongside any old-style declarations of graph edges.
@ -903,6 +903,6 @@ In Javascript config parameters can be set by using `mermaid.flowchartConfig`:
```javascript ```javascript
mermaid.flowchartConfig = { mermaid.flowchartConfig = {
width: '100%', width: '100%',
}; };
``` ```

52
docs/directives.md
View File

@ -16,12 +16,12 @@ Mermaid basically supports two types of configuration options to be overridden b
1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are: 1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are:
- theme - theme
- fontFamily - fontFamily
- logLevel - logLevel
- securityLevel - securityLevel
- startOnLoad - startOnLoad
- secure - secure
2. _Diagram specific configurations_ : These are the configurations that are available and applied to a specific diagram. For each diagram there are specific configuration that will alter how that particular diagram looks and behaves. 2. _Diagram specific configurations_ : These are the configurations that are available and applied to a specific diagram. For each diagram there are specific configuration that will alter how that particular diagram looks and behaves.
For example, `mirrorActors` is a configuration that is specific to the `SequenceDiagram` and alter whether the actors are mirrored or not. So this config is available only for the `SequenceDiagram` type. For example, `mirrorActors` is a configuration that is specific to the `SequenceDiagram` and alter whether the actors are mirrored or not. So this config is available only for the `SequenceDiagram` type.
@ -95,9 +95,9 @@ parsing the above generates a single `%%init%%` JSON object below, combining the
```json5 ```json5
{ {
logLevel: 'fatal', logLevel: 'fatal',
theme: 'dark', theme: 'dark',
startOnLoad: true, startOnLoad: true,
} }
``` ```
@ -183,11 +183,11 @@ The following code snippet changes theme to forest:
Possible logLevel values are: Possible logLevel values are:
- `1` for _debug_, - `1` for _debug_,
- `2` for _info_ - `2` for _info_
- `3` for _warn_ - `3` for _warn_
- `4` for _error_ - `4` for _error_
- `5` for _only fatal errors_ - `5` for _only fatal errors_
Default Value is `5`. Default Value is `5`.
@ -219,10 +219,10 @@ A --> C[End]
Some common flowchart configurations are: Some common flowchart configurations are:
- _htmlLabels_: true/false - _htmlLabels_: true/false
- _curve_: linear/curve - _curve_: linear/curve
- _diagramPadding_: number - _diagramPadding_: number
- _useMaxWidth_: number - _useMaxWidth_: number
For complete list of flowchart configurations, see [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code. For complete list of flowchart configurations, see [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code.
_Soon we plan to publish a complete list all diagram specific configurations updated in the docs_ _Soon we plan to publish a complete list all diagram specific configurations updated in the docs_
@ -259,14 +259,14 @@ A --> C[End]
Some common sequence configurations are: Some common sequence configurations are:
- _width_: number - _width_: number
- _height_: number - _height_: number
- _messageAlign_: left, center, right - _messageAlign_: left, center, right
- _mirrorActors_: boolean - _mirrorActors_: boolean
- _useMaxWidth_: boolean - _useMaxWidth_: boolean
- _rightAngles_: boolean - _rightAngles_: boolean
- _showSequenceNumbers_: boolean - _showSequenceNumbers_: boolean
- _wrap_: boolean - _wrap_: boolean
For complete list of sequence diagram configurations, see _defaultConfig.js_ in the source code. For complete list of sequence diagram configurations, see _defaultConfig.js_ in the source code.
_Soon we plan to publish a complete list all diagram specific configurations updated in the docs_ _Soon we plan to publish a complete list all diagram specific configurations updated in the docs_

18
docs/entityRelationshipDiagram.md
View File

@ -80,10 +80,10 @@ Mermaid syntax for ER diagrams is compatible with PlantUML, with an extension to
Where: Where:
- `first-entity` is the name of an entity. Names must begin with an alphabetic character and may also contain digits, hyphens, and underscores. - `first-entity` is the name of an entity. Names must begin with an alphabetic character and may also contain digits, hyphens, and underscores.
- `relationship` describes the way that both entities inter-relate. See below. - `relationship` describes the way that both entities inter-relate. See below.
- `second-entity` is the name of the other entity. - `second-entity` is the name of the other entity.
- `relationship-label` describes the relationship from the perspective of the first entity. - `relationship-label` describes the relationship from the perspective of the first entity.
For example: For example:
@ -97,9 +97,9 @@ Only the `first-entity` part of a statement is mandatory. This makes it possible
The `relationship` part of each statement can be broken down into three sub-components: The `relationship` part of each statement can be broken down into three sub-components:
- the cardinality of the first entity with respect to the second, - the cardinality of the first entity with respect to the second,
- whether the relationship confers identity on a 'child' entity - whether the relationship confers identity on a 'child' entity
- the cardinality of the second entity with respect to the first - the cardinality of the second entity with respect to the first
Cardinality is a property that describes how many elements of another entity can be related to the entity in question. In the above example a `PROPERTY` can have one or more `ROOM` instances associated to it, whereas a `ROOM` can only be associated with one `PROPERTY`. In each cardinality marker there are two characters. The outermost character represents a maximum value, and the innermost character represents a minimum value. The table below summarises possible cardinalities. Cardinality is a property that describes how many elements of another entity can be related to the entity in question. In the above example a `PROPERTY` can have one or more `ROOM` instances associated to it, whereas a `ROOM` can only be associated with one `PROPERTY`. In each cardinality marker there are two characters. The outermost character represents a maximum value, and the innermost character represents a minimum value. The table below summarises possible cardinalities.
@ -234,8 +234,8 @@ erDiagram
### Other Things ### Other Things
- If you want the relationship label to be more than one word, you must use double quotes around the phrase - If you want the relationship label to be more than one word, you must use double quotes around the phrase
- If you don't want a label at all on a relationship, you must use an empty double-quoted string - If you don't want a label at all on a relationship, you must use an empty double-quoted string
## Styling ## Styling

66
docs/flowchart.md
View File

@ -70,11 +70,11 @@ flowchart LR
Possible FlowChart orientations are: Possible FlowChart orientations are:
- TB - top to bottom - TB - top to bottom
- TD - top-down/ same as top to bottom - TD - top-down/ same as top to bottom
- BT - bottom to top - BT - bottom to top
- RL - right to left - RL - right to left
- LR - left to right - LR - left to right
## Node shapes ## Node shapes
@ -678,16 +678,16 @@ It is possible to bind a click event to a node, the click can lead to either a j
click nodeId callback click nodeId callback
click nodeId call callback() click nodeId call callback()
- nodeId is the id of the node - nodeId is the id of the node
- callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the nodeId as parameter. - callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the nodeId as parameter.
Examples of tooltip usage below: Examples of tooltip usage below:
```html ```html
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
</script> </script>
``` ```
@ -749,23 +749,23 @@ Beginner's tip—a full example using interactive links in a html context:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
flowchart LR A-->B B-->C C-->D click A callback "Tooltip" click B "https://www.github.com" flowchart LR A-->B B-->C C-->D click A callback "Tooltip" click B "https://www.github.com" "This
"This is a link" click C call callback() "Tooltip" click D href "https://www.github.com" is a link" click C call callback() "Tooltip" click D href "https://www.github.com" "This is a
"This is a link" link"
</div> </div>
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' }, flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' },
securityLevel: 'loose', securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
</body> </body>
``` ```
@ -863,11 +863,11 @@ below:
```html ```html
<style> <style>
.cssClass > rect { .cssClass > rect {
fill: #ff0000; fill: #ff0000;
stroke: #ffff00; stroke: #ffff00;
stroke-width: 4px; stroke-width: 4px;
} }
</style> </style>
``` ```
@ -919,9 +919,9 @@ flowchart TD
## Graph declarations with spaces between vertices and link and without semicolon ## Graph declarations with spaces between vertices and link and without semicolon
- In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph. - In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph.
- A single space is allowed between vertices and the link. However there should not be any space between a vertex and its text and a link and its text. The old syntax of graph declaration will also work and hence this new feature is optional and is introduced to improve readability. - A single space is allowed between vertices and the link. However there should not be any space between a vertex and its text and a link and its text. The old syntax of graph declaration will also work and hence this new feature is optional and is introduced to improve readability.
Below is the new declaration of the graph edges which is also valid along with the old declaration of the graph edges. Below is the new declaration of the graph edges which is also valid along with the old declaration of the graph edges.

132
docs/gantt.md
View File

@ -254,61 +254,61 @@ Styling of the a gantt diagram is done by defining a number of css classes. Duri
### Classes used ### Classes used
Class | Description | Class | Description |
\--- | --- | --------------------- | ---------------------------------------------------------------------- |
grid.tick | Styling for the Grid Lines | grid.tick | Styling for the Grid Lines |
grid.path | Styling for the Grid's borders | grid.path | Styling for the Grid's borders |
.taskText | Task Text Styling | .taskText | Task Text Styling |
.taskTextOutsideRight | Styling for Task Text that exceeds the activity bar towards the right. | .taskTextOutsideRight | Styling for Task Text that exceeds the activity bar towards the right. |
.taskTextOutsideLeft | Styling for Task Text that exceeds the activity bar, towards the left. | .taskTextOutsideLeft | Styling for Task Text that exceeds the activity bar, towards the left. |
todayMarker | Toggle and Styling for the "Today Marker" | todayMarker | Toggle and Styling for the "Today Marker" |
### Sample stylesheet ### Sample stylesheet
```css ```css
.grid .tick { .grid .tick {
stroke: lightgrey; stroke: lightgrey;
opacity: 0.3; opacity: 0.3;
shape-rendering: crispEdges; shape-rendering: crispEdges;
} }
.grid path { .grid path {
stroke-width: 0; stroke-width: 0;
} }
#tag { #tag {
color: white; color: white;
background: #fa283d; background: #fa283d;
width: 150px; width: 150px;
position: absolute; position: absolute;
display: none; display: none;
padding: 3px 6px; padding: 3px 6px;
margin-left: -80px; margin-left: -80px;
font-size: 11px; font-size: 11px;
} }
#tag:before { #tag:before {
border: solid transparent; border: solid transparent;
content: ' '; content: ' ';
height: 0; height: 0;
left: 50%; left: 50%;
margin-left: -5px; margin-left: -5px;
position: absolute; position: absolute;
width: 0; width: 0;
border-width: 10px; border-width: 10px;
border-bottom-color: #fa283d; border-bottom-color: #fa283d;
top: -20px; top: -20px;
} }
.taskText { .taskText {
fill: white; fill: white;
text-anchor: middle; text-anchor: middle;
} }
.taskTextOutsideRight { .taskTextOutsideRight {
fill: black; fill: black;
text-anchor: start; text-anchor: start;
} }
.taskTextOutsideLeft { .taskTextOutsideLeft {
fill: black; fill: black;
text-anchor: end; text-anchor: end;
} }
``` ```
@ -333,20 +333,20 @@ mermaid.ganttConfig can be set to a JSON string with config parameters or the co
```javascript ```javascript
mermaid.ganttConfig = { mermaid.ganttConfig = {
titleTopMargin: 25, titleTopMargin: 25,
barHeight: 20, barHeight: 20,
barGap: 4, barGap: 4,
topPadding: 75, topPadding: 75,
sidePadding: 75, sidePadding: 75,
}; };
``` ```
### Possible configuration params: ### Possible configuration params:
Param | Description | Default value | Param | Description | Default value |
\--- | --- | --- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
mirrorActor|Turns on/off the rendering of actors below the diagram as well as above it|false | mirrorActor | Turns on/off the rendering of actors below the diagram as well as above it | false |
bottomMarginAdj|Adjusts how far down the graph ended. Wide borders styles with css could generate unwanted clipping which is why this config param exists.|1 | bottomMarginAdj | Adjusts how far down the graph ended. Wide borders styles with css could generate unwanted clipping which is why this config param exists. | 1 |
## Interaction ## Interaction
@ -355,32 +355,32 @@ It is possible to bind a click event to a task. The click can lead to either a j
click taskId call callback(arguments) click taskId call callback(arguments)
click taskId href URL click taskId href URL
- taskId is the id of the task - taskId is the id of the task
- callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the taskId as the parameter if no other arguments are specified. - callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the taskId as the parameter if no other arguments are specified.
Beginner's tip—a full example using interactive links in an html context: Beginner's tip—a full example using interactive links in an html context:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
gantt dateFormat YYYY-MM-DD section Clickable Visit mermaidjs :active, cl1, 2014-01-07, 3d gantt dateFormat YYYY-MM-DD section Clickable Visit mermaidjs :active, cl1, 2014-01-07, 3d Print
Print arguments :cl2, after cl1, 3d Print task :cl3, after cl2, 3d click cl1 href arguments :cl2, after cl1, 3d Print task :cl3, after cl2, 3d click cl1 href
"https://mermaidjs.github.io/" click cl2 call printArguments("test1", "test2", test3) click "https://mermaidjs.github.io/" click cl2 call printArguments("test1", "test2", test3) click cl3
cl3 call printTask() call printTask()
</div> </div>
<script> <script>
var printArguments = function (arg1, arg2, arg3) { var printArguments = function (arg1, arg2, arg3) {
alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3); alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3);
}; };
var printTask = function (taskId) { var printTask = function (taskId) {
alert('taskId: ' + taskId); alert('taskId: ' + taskId);
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
securityLevel: 'loose', securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
</body> </body>
``` ```

44
docs/gitgraph.md
View File

@ -38,10 +38,10 @@ Mermaid can render Git diagrams
In Mermaid, we support the basic git operations like: In Mermaid, we support the basic git operations like:
- _commit_ : Representing a new commit on the current branch. - _commit_ : Representing a new commit on the current branch.
- _branch_ : To create & switch to a new branch, setting it as the current branch. - _branch_ : To create & switch to a new branch, setting it as the current branch.
- _checkout_ : To checking out an existing branch and setting it as the current branch. - _checkout_ : To checking out an existing branch and setting it as the current branch.
- _merge_ : To merge an existing branch onto the current branch. - _merge_ : To merge an existing branch onto the current branch.
With the help of these key git commands, you will be able to draw a gitgraph in Mermaid very easily and quickly. With the help of these key git commands, you will be able to draw a gitgraph in Mermaid very easily and quickly.
Entity names are often capitalized, although there is no accepted standard on this, and it is not required in Mermaid. Entity names are often capitalized, although there is no accepted standard on this, and it is not required in Mermaid.
@ -100,9 +100,9 @@ In this example, we have given our custom IDs to the commits.
In Mermaid, a commit can be of three type, which render a bit different in the diagram. These types are: In Mermaid, a commit can be of three type, which render a bit different in the diagram. These types are:
- `NORMAL` : Default commit type. Represented by a solid circle in the diagram - `NORMAL` : Default commit type. Represented by a solid circle in the diagram
- `REVERSE` : To emphasize a commit as a reverse commit. Represented by a crossed solid circle in the diagram. - `REVERSE` : To emphasize a commit as a reverse commit. Represented by a crossed solid circle in the diagram.
- `HIGHLIGHT` : To highlight a particular commit in the diagram. Represented by a filled rectangle in the diagram. - `HIGHLIGHT` : To highlight a particular commit in the diagram. Represented by a filled rectangle in the diagram.
For a given commit you may specify its type at the time of declaring it using the `type` attribute, followed by `:` and the required type option discussed above. For example: `commit type: HIGHLIGHT` For a given commit you may specify its type at the time of declaring it using the `type` attribute, followed by `:` and the required type option discussed above. For example: `commit type: HIGHLIGHT`
@ -282,9 +282,9 @@ Since the current branch at this point is still `main`, the last two commits are
You can also decorate your merge with similar attributes as you did for the commit using: You can also decorate your merge with similar attributes as you did for the commit using:
- `id`--> To override the default ID with custom ID - `id`--> To override the default ID with custom ID
- `tag`--> To add a custom tag to your merge commit - `tag`--> To add a custom tag to your merge commit
- `type`--> To override the default shape of merge commit. Here you can use other commit type mentioned earlier. - `type`--> To override the default shape of merge commit. Here you can use other commit type mentioned earlier.
And you can choose to use none, some or all of these attributes together. And you can choose to use none, some or all of these attributes together.
For example: `merge develop id: "my_custom_id" tag: "my_custom_tag" type: REVERSE` For example: `merge develop id: "my_custom_id" tag: "my_custom_tag" type: REVERSE`
@ -397,10 +397,10 @@ Let see an example:
In Mermaid, you have the option to configure the gitgraph diagram. You can configure the following options: In Mermaid, you have the option to configure the gitgraph diagram. You can configure the following options:
- `showBranches` : Boolean, default is `true`. If set to `false`, the branches are not shown in the diagram. - `showBranches` : Boolean, default is `true`. If set to `false`, the branches are not shown in the diagram.
- `showCommitLabel` : Boolean, default is `true`. If set to `false`, the commit labels are not shown in the diagram. - `showCommitLabel` : Boolean, default is `true`. If set to `false`, the commit labels are not shown in the diagram.
- `mainBranchName` : String, default is `main`. The name of the default/root branch. - `mainBranchName` : String, default is `main`. The name of the default/root branch.
- `mainBranchOrder` : Position of the main branch in the list of branches. default is `0`, meaning, by default `main` branch is the first in the order. - `mainBranchOrder` : Position of the main branch in the list of branches. default is `0`, meaning, by default `main` branch is the first in the order.
Let's look at them one by one. Let's look at them one by one.
@ -752,9 +752,9 @@ Sometimes you may want to customize the order of the branches. You can do this b
Mermaid follows the given precedence order of the `order` keyword. Mermaid follows the given precedence order of the `order` keyword.
- Main branch is always shown first as it has default order value of `0`. (unless its order is modified and changed from `0` using the `mainBranchOrder` keyword in the config) - Main branch is always shown first as it has default order value of `0`. (unless its order is modified and changed from `0` using the `mainBranchOrder` keyword in the config)
- Next, All branches without an `order` are shown in the order of their appearance in the diagram code. - Next, All branches without an `order` are shown in the order of their appearance in the diagram code.
- Next, All branches with an `order` are shown in the order of their `order` value. - Next, All branches with an `order` are shown in the order of their `order` value.
To fully control the order of all the branches, you must define `order` for all the branches. To fully control the order of all the branches, you must define `order` for all the branches.
@ -821,11 +821,11 @@ Mermaid supports a bunch of pre-defined themes which you can use to find the rig
The following are the different pre-defined theme options: The following are the different pre-defined theme options:
- `base` - `base`
- `forest` - `forest`
- `dark` - `dark`
- `default` - `default`
- `neutral` - `neutral`
**NOTE**: To change theme you can either use the `initialize` call or _directives_. Learn more about [directives](./directives.md) **NOTE**: To change theme you can either use the `initialize` call or _directives_. Learn more about [directives](./directives.md)
Let's put them to use, and see how our sample diagram looks in different themes: Let's put them to use, and see how our sample diagram looks in different themes:

258
docs/integrations.md
View File

@ -8,144 +8,144 @@ They also serve as proof of concept, for the variety of things that can be built
## Productivity ## Productivity
- [GitHub](https://github.com) (**Native support**) - [GitHub](https://github.com) (**Native support**)
- [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) (**Native support**) - [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) (**Native support**)
- [GitHub action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action) - [GitHub action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action)
- [svg-generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator) - [svg-generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator)
- [GitLab](https://docs.gitlab.com/ee/user/markdown.html#diagrams-and-flowcharts) (**Native support**) - [GitLab](https://docs.gitlab.com/ee/user/markdown.html#diagrams-and-flowcharts) (**Native support**)
- [Gitea](https://gitea.io) (**Native support**) - [Gitea](https://gitea.io) (**Native support**)
- [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) (**Native support**) - [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) (**Native support**)
- [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**) - [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**)
- [Joplin](https://joplinapp.org) (**Native support**) - [Joplin](https://joplinapp.org) (**Native support**)
- [Notion](https://notion.so) (**Native support**) - [Notion](https://notion.so) (**Native support**)
- [Observable](https://observablehq.com/@observablehq/mermaid) (**Native support**) - [Observable](https://observablehq.com/@observablehq/mermaid) (**Native support**)
- [GitBook](https://gitbook.com) - [GitBook](https://gitbook.com)
- [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid) - [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid)
- [Markdown with Mermaid CLI](https://github.com/miao1007/gitbook-plugin-mermaid-cli) - [Markdown with Mermaid CLI](https://github.com/miao1007/gitbook-plugin-mermaid-cli)
- [Mermaid plugin for GitBook](https://github.com/wwformat/gitbook-plugin-mermaid-pdf) - [Mermaid plugin for GitBook](https://github.com/wwformat/gitbook-plugin-mermaid-pdf)
- [LiveBook](https://livebook.dev) (**Native support**) - [LiveBook](https://livebook.dev) (**Native support**)
- [Atlassian Products](https://www.atlassian.com) - [Atlassian Products](https://www.atlassian.com)
- [Mermaid Plugin for Confluence](https://marketplace.atlassian.com/apps/1214124/mermaid-plugin-for-confluence?hosting=server&tab=overview) - [Mermaid Plugin for Confluence](https://marketplace.atlassian.com/apps/1214124/mermaid-plugin-for-confluence?hosting=server&tab=overview)
- [CloudScript.io Addon](https://marketplace.atlassian.com/apps/1219878/cloudscript-io-mermaid-addon?hosting=cloud&tab=overview) - [CloudScript.io Addon](https://marketplace.atlassian.com/apps/1219878/cloudscript-io-mermaid-addon?hosting=cloud&tab=overview)
- [Auto convert diagrams in Jira](https://github.com/coddingtonbear/jirafs-mermaid) - [Auto convert diagrams in Jira](https://github.com/coddingtonbear/jirafs-mermaid)
- [Redmine](https://redmine.org) - [Redmine](https://redmine.org)
- [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro) - [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro)
- [redmine-mermaid](https://github.com/styz/redmine_mermaid) - [redmine-mermaid](https://github.com/styz/redmine_mermaid)
- [markdown-for-mermaid-plugin](https://github.com/jamieh-mongolian/markdown-for-mermaid-plugin) - [markdown-for-mermaid-plugin](https://github.com/jamieh-mongolian/markdown-for-mermaid-plugin)
- [Jetsbrain IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/) - [Jetsbrain IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/)
## CRM/ERP/Similar ## CRM/ERP/Similar
- [coreBOS](https://blog.corebos.org/blog/december2019) - [coreBOS](https://blog.corebos.org/blog/december2019)
## Blogs ## Blogs
- [Wordpress](https://wordpress.org) - [Wordpress](https://wordpress.org)
- [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md) - [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md)
- [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/) - [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/)
- [Hexo](https://hexo.io) - [Hexo](https://hexo.io)
- [hexo-filter-mermaid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams) - [hexo-filter-mermaid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams)
- [hexo-tag-mermaid](https://github.com/JameChou/hexo-tag-mermaid) - [hexo-tag-mermaid](https://github.com/JameChou/hexo-tag-mermaid)
- [hexo-mermaid-diagrams](https://github.com/mslxl/hexo-mermaid-diagrams) - [hexo-mermaid-diagrams](https://github.com/mslxl/hexo-mermaid-diagrams)
## CMS ## CMS
- [VuePress](https://vuepress.vuejs.org/) - [VuePress](https://vuepress.vuejs.org/)
- [Plugin for Mermaid.js](https://github.com/eFrane/vuepress-plugin-mermaidjs) - [Plugin for Mermaid.js](https://github.com/eFrane/vuepress-plugin-mermaidjs)
- [Grav CMS](https://getgrav.org/) - [Grav CMS](https://getgrav.org/)
- [Mermaid Diagrams](https://github.com/DanielFlaum/grav-plugin-mermaid-diagrams) - [Mermaid Diagrams](https://github.com/DanielFlaum/grav-plugin-mermaid-diagrams)
- [Gitlab Markdown Adapter](https://github.com/Goutte/grav-plugin-gitlab-markdown-adapter) - [Gitlab Markdown Adapter](https://github.com/Goutte/grav-plugin-gitlab-markdown-adapter)
## Communication ## Communication
- [Discourse](https://discourse.org) - [Discourse](https://discourse.org)
- [Mermaid Plugin](https://github.com/pnewell/discourse-mermaid), [And](https://github.com/unfoldingWord-dev/discourse-mermaid) - [Mermaid Plugin](https://github.com/pnewell/discourse-mermaid), [And](https://github.com/unfoldingWord-dev/discourse-mermaid)
- [Mattermost](https://mattermost.com/) - [Mattermost](https://mattermost.com/)
- [Mermaid Plugin](https://github.com/SpikeTings/Mermaid) - [Mermaid Plugin](https://github.com/SpikeTings/Mermaid)
- [phpBB](https://phpbb.com) - [phpBB](https://phpbb.com)
- [phpbb-ext-mermaid](https://github.com/AlfredoRamos/phpbb-ext-mermaid) - [phpbb-ext-mermaid](https://github.com/AlfredoRamos/phpbb-ext-mermaid)
- [NodeBB](https://nodebb.org) - [NodeBB](https://nodebb.org)
- [Mermaid Plugin](https://www.npmjs.com/package/nodebb-plugin-mermaid) - [Mermaid Plugin](https://www.npmjs.com/package/nodebb-plugin-mermaid)
## Wikis ## Wikis
- [MediaWiki](https://www.mediawiki.org) - [MediaWiki](https://www.mediawiki.org)
- [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid) - [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid)
- [Flex Diagrams Extension](https://www.mediawiki.org/wiki/Extension:Flex_Diagrams) - [Flex Diagrams Extension](https://www.mediawiki.org/wiki/Extension:Flex_Diagrams)
- [Semantic Media Wiki](https://semantic-mediawiki.org) - [Semantic Media Wiki](https://semantic-mediawiki.org)
- [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid) - [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid)
- [FosWiki](https://foswiki.org) - [FosWiki](https://foswiki.org)
- [Mermaid Plugin](https://foswiki.org/Extensions/MermaidPlugin) - [Mermaid Plugin](https://foswiki.org/Extensions/MermaidPlugin)
- [DokuWiki](https://dokuwiki.org) - [DokuWiki](https://dokuwiki.org)
- [Flowcharts](https://www.dokuwiki.org/plugin:flowcharts?s[]=mermaid) - [Flowcharts](https://www.dokuwiki.org/plugin:flowcharts?s[]=mermaid)
- [ComboStrap](https://combostrap.com/mermaid) - [ComboStrap](https://combostrap.com/mermaid)
- [TiddlyWiki](https://tiddlywiki.com/) - [TiddlyWiki](https://tiddlywiki.com/)
- [mermaid-tw5: full js library](https://github.com/efurlanm/mermaid-tw5) - [mermaid-tw5: full js library](https://github.com/efurlanm/mermaid-tw5)
- [tw5-mermaid: wrapper for Mermaid Live](https://github.com/jasonmhoule/tw5-mermaid) - [tw5-mermaid: wrapper for Mermaid Live](https://github.com/jasonmhoule/tw5-mermaid)
## Editor Plugins ## Editor Plugins
- [Vs Code](https://code.visualstudio.com/) - [Vs Code](https://code.visualstudio.com/)
- [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) - [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
- [Mermaid Preview](https://marketplace.visualstudio.com/items?itemName=vstirbu.vscode-mermaid-preview) - [Mermaid Preview](https://marketplace.visualstudio.com/items?itemName=vstirbu.vscode-mermaid-preview)
- [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting) - [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting)
- [Mermaid Editor](https://marketplace.visualstudio.com/items?itemName=tomoyukim.vscode-mermaid-editor) - [Mermaid Editor](https://marketplace.visualstudio.com/items?itemName=tomoyukim.vscode-mermaid-editor)
- [Mermaid Export](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.mermaid-export) - [Mermaid Export](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.mermaid-export)
- [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf) - [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf)
- [Preview](https://marketplace.visualstudio.com/items?itemName=searKing.preview-vscode) - [Preview](https://marketplace.visualstudio.com/items?itemName=searKing.preview-vscode)
- [Preview Sequence Diagrams](https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode) - [Preview Sequence Diagrams](https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode)
- [Markdown-It](https://github.com/markdown-it/markdown-it) - [Markdown-It](https://github.com/markdown-it/markdown-it)
- [Textual UML Parser](https://github.com/manastalukdar/markdown-it-textual-uml) - [Textual UML Parser](https://github.com/manastalukdar/markdown-it-textual-uml)
- [Mermaid Plugin](https://github.com/tylingsoft/markdown-it-mermaid) - [Mermaid Plugin](https://github.com/tylingsoft/markdown-it-mermaid)
- [md-it-mermaid](https://github.com/iamcco/md-it-mermaid) - [md-it-mermaid](https://github.com/iamcco/md-it-mermaid)
- [markdown-it-mermaid-fence-new](https://github.com/Revomatico/markdown-it-mermaid-fence-new) - [markdown-it-mermaid-fence-new](https://github.com/Revomatico/markdown-it-mermaid-fence-new)
- [markdown-it-mermaid-less](https://github.com/searKing/markdown-it-mermaid-less) - [markdown-it-mermaid-less](https://github.com/searKing/markdown-it-mermaid-less)
- [Atom](https://atom.io) - [Atom](https://atom.io)
- [Markdown Preview Enhanced](https://atom.io/packages/markdown-preview-enhanced) - [Markdown Preview Enhanced](https://atom.io/packages/markdown-preview-enhanced)
- [Atom Mermaid](https://atom.io/packages/atom-mermaid) - [Atom Mermaid](https://atom.io/packages/atom-mermaid)
- [Language Mermaid Syntax Highlighter](https://atom.io/packages/language-mermaid) - [Language Mermaid Syntax Highlighter](https://atom.io/packages/language-mermaid)
- [Sublime Text 3](https://sublimetext.com) - [Sublime Text 3](https://sublimetext.com)
- [Mermaid Package](https://packagecontrol.io/packages/Mermaid) - [Mermaid Package](https://packagecontrol.io/packages/Mermaid)
- [Astah](https://astah.net) - [Astah](https://astah.net)
- [Export to Mermaid](https://github.com/Avens666/Astah_Jude_UML_export_to_Markdown-mermaid-Plantuml-) - [Export to Mermaid](https://github.com/Avens666/Astah_Jude_UML_export_to_Markdown-mermaid-Plantuml-)
- [Light Table](http://lighttable.com/) - [Light Table](http://lighttable.com/)
- [Mermaid Plugin](https://github.com/cldwalker/Mermaid) - [Mermaid Plugin](https://github.com/cldwalker/Mermaid)
- [Draw.io](https://draw.io) - [Plugin](https://github.com/nopeslide/drawio_mermaid_plugin) - [Draw.io](https://draw.io) - [Plugin](https://github.com/nopeslide/drawio_mermaid_plugin)
- [Inkdrop](https://www.inkdrop.app) - [Plugin](https://github.com/inkdropapp/inkdrop-mermaid) - [Inkdrop](https://www.inkdrop.app) - [Plugin](https://github.com/inkdropapp/inkdrop-mermaid)
- [Vim](https://www.vim.org) - [Vim](https://www.vim.org)
- [Vim Diagram Syntax](https://github.com/zhaozg/vim-diagram) - [Vim Diagram Syntax](https://github.com/zhaozg/vim-diagram)
- [GNU Emacs](https://www.gnu.org/software/emacs/) - [GNU Emacs](https://www.gnu.org/software/emacs/)
- [Major mode for .mmd files](https://github.com/abrochard/mermaid-mode) - [Major mode for .mmd files](https://github.com/abrochard/mermaid-mode)
- [Org-Mode integration](https://github.com/arnm/ob-mermaid) - [Org-Mode integration](https://github.com/arnm/ob-mermaid)
- [Brackets](https://brackets.io/) - [Brackets](https://brackets.io/)
- [Mermaid Preview](https://github.com/AlanHohn/mermaid-preview) - [Mermaid Preview](https://github.com/AlanHohn/mermaid-preview)
- [Iodide](https://github.com/iodide-project/iodide) - [Iodide](https://github.com/iodide-project/iodide)
- [iodide-mermaid-plugin](https://github.com/iodide-project/iodide-mermaid-plugin) - [iodide-mermaid-plugin](https://github.com/iodide-project/iodide-mermaid-plugin)
- [Google docs](https://docs.google.com/) - [Google docs](https://docs.google.com/)
- [Mermaid plugin for google docs](https://workspace.google.com/marketplace/app/mermaid/636321283856) - [Mermaid plugin for google docs](https://workspace.google.com/marketplace/app/mermaid/636321283856)
- [Podlite](https://github.com/zag/podlite-desktop) - [Podlite](https://github.com/zag/podlite-desktop)
- [Named block =Diagram](https://github.com/zag/podlite/tree/main/packages/podlite-diagrams) - [Named block =Diagram](https://github.com/zag/podlite/tree/main/packages/podlite-diagrams)
- [GNU Nano](https://www.nano-editor.org/) - [GNU Nano](https://www.nano-editor.org/)
- [Nano Mermaid](https://github.com/Yash-Singh1/nano-mermaid) - [Nano Mermaid](https://github.com/Yash-Singh1/nano-mermaid)
## Document Generation ## Document Generation
- [Sphinx](https://www.sphinx-doc.org/en/master/) - [Sphinx](https://www.sphinx-doc.org/en/master/)
- [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) - [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid)
- [remark.js](https://remark.js.org/) - [remark.js](https://remark.js.org/)
- [remark-mermaid](https://github.com/temando/remark-mermaid) - [remark-mermaid](https://github.com/temando/remark-mermaid)
- [jSDoc](https://jsdoc.app/) - [jSDoc](https://jsdoc.app/)
- [jsdoc-mermaid](https://github.com/Jellyvision/jsdoc-mermaid) - [jsdoc-mermaid](https://github.com/Jellyvision/jsdoc-mermaid)
- [MkDocs](https://mkdocs.org) - [MkDocs](https://mkdocs.org)
- [mkdocs-mermaid2-plugin](https://github.com/fralau/mkdocs-mermaid2-plugin) - [mkdocs-mermaid2-plugin](https://github.com/fralau/mkdocs-mermaid2-plugin)
- [mkdocs-material](https://github.com/squidfunk/mkdocs-material), check the [docs](https://squidfunk.github.io/mkdocs-material/reference/diagrams/) - [mkdocs-material](https://github.com/squidfunk/mkdocs-material), check the [docs](https://squidfunk.github.io/mkdocs-material/reference/diagrams/)
- [Type Doc](https://typedoc.org/) - [Type Doc](https://typedoc.org/)
- [typedoc-plugin-mermaid](https://www.npmjs.com/package/typedoc-plugin-mermaid) - [typedoc-plugin-mermaid](https://www.npmjs.com/package/typedoc-plugin-mermaid)
- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) (Native support in theme) - [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) (Native support in theme)
- [Codedoc](https://codedoc.cc/) - [Codedoc](https://codedoc.cc/)
- [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin) - [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin)
- [mdbook](https://rust-lang.github.io/mdBook/index.html) - [mdbook](https://rust-lang.github.io/mdBook/index.html)
- [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid)
## Browser Extensions ## Browser Extensions
@ -165,15 +165,15 @@ They also serve as proof of concept, for the variety of things that can be built
## Other ## Other
- [Jekyll](https://jekyllrb.com/) - [Jekyll](https://jekyllrb.com/)
- [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid) - [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid)
- [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams) - [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams)
- [Reveal.js](https://github.com/hakimel/reveal.js) - [Reveal.js](https://github.com/hakimel/reveal.js)
- [reveal.js-mermaid-plugin](https://github.com/ludwick/reveal.js-mermaid-plugin) - [reveal.js-mermaid-plugin](https://github.com/ludwick/reveal.js-mermaid-plugin)
- [Bisheng](https://www.npmjs.com/package/bisheng) - [Bisheng](https://www.npmjs.com/package/bisheng)
- [bisheng-plugin-mermaid](https://github.com/yct21/bisheng-plugin-mermaid) - [bisheng-plugin-mermaid](https://github.com/yct21/bisheng-plugin-mermaid)
- [Reveal CK](https://github.com/jedcn/reveal-ck) - [Reveal CK](https://github.com/jedcn/reveal-ck)
- [reveal-ck-mermaid-plugin](https://github.com/tmtm/reveal-ck-mermaid-plugin) - [reveal-ck-mermaid-plugin](https://github.com/tmtm/reveal-ck-mermaid-plugin)
- [mermaid-server: Generate diagrams using a HTTP request](https://github.com/TomWright/mermaid-server) - [mermaid-server: Generate diagrams using a HTTP request](https://github.com/TomWright/mermaid-server)
- [ExDoc](https://github.com/elixir-lang/ex_doc) - [ExDoc](https://github.com/elixir-lang/ex_doc)
- [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs) - [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs)

50
docs/landing/index.html
View File

@ -49,16 +49,7 @@
<div class="pt-24"> <div class="pt-24">
<div <div
style="" style=""
class=" class="container lg:px-24 max-w-5xl px-4 mx-auto flex flex-wrap flex-col md:flex-row items-center"
container
lg:px-24
max-w-5xl
px-4
mx-auto
flex flex-wrap flex-col
md:flex-row
items-center
"
> >
<!--Left Col--> <!--Left Col-->
<div class="w-full md:w-1/2"> <div class="w-full md:w-1/2">
@ -77,24 +68,7 @@
> >
<button <button
style="background: #ffa41c; border: 1px solid #ff8f00" style="background: #ffa41c; border: 1px solid #ff8f00"
class=" class="mx-auto lg:mx-0 hover:underline text-black font-bold rounded-full my-6 py-4 px-8 shadow-lg focus:outline-none focus:shadow-outline transform transition hover:scale-105 duration-300 ease-in-out"
mx-auto
lg:mx-0
hover:underline
text-black
font-bold
rounded-full
my-6
py-4
px-8
shadow-lg
focus:outline-none focus:shadow-outline
transform
transition
hover:scale-105
duration-300
ease-in-out
"
> >
Purchase on Amazon Purchase on Amazon
</button> </button>
@ -352,25 +326,7 @@
> >
<button <button
style="background: #ffa41c; border: 1px solid #ff8f00" style="background: #ffa41c; border: 1px solid #ff8f00"
class=" class="mx-auto lg:mx-0 hover:underline bg-white text-gray-800 font-bold rounded-full my-6 py-4 px-8 shadow-lg focus:outline-none focus:shadow-outline transform transition hover:scale-105 duration-300 ease-in-out"
mx-auto
lg:mx-0
hover:underline
bg-white
text-gray-800
font-bold
rounded-full
my-6
py-4
px-8
shadow-lg
focus:outline-none focus:shadow-outline
transform
transition
hover:scale-105
duration-300
ease-in-out
"
> >
Purchase Now on Amazon Purchase Now on Amazon
</button> </button>

74
docs/n00b-gettingStarted.md
View File

@ -87,7 +87,7 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an
```html ```html
<body> <body>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
</body> </body>
``` ```
@ -95,10 +95,10 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an
```html ```html
<body> <body>
Here is a mermaid diagram: Here is a mermaid diagram:
<div class="mermaid"> <div class="mermaid">
graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02] graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02]
</div> </div>
</body> </body>
``` ```
@ -110,9 +110,9 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an
```html ```html
<body> <body>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
</body> </body>
``` ```
@ -131,23 +131,23 @@ Rendering in Mermaid is initialized by `mermaid.initialize()` call. You can plac
```html ```html
<html> <html>
<body> <body>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
Here is one mermaid diagram: Here is one mermaid diagram:
<div class="mermaid"> <div class="mermaid">
graph TD A[Client] --> B[Load Balancer] B --> C[Server1] B --> D[Server2] graph TD A[Client] --> B[Load Balancer] B --> C[Server1] B --> D[Server2]
</div> </div>
And here is another: And here is another:
<div class="mermaid"> <div class="mermaid">
graph TD A[Client] -->|tcp_123| B B(Load Balancer) B -->|tcp_456| C[Server1] B graph TD A[Client] -->|tcp_123| B B(Load Balancer) B -->|tcp_456| C[Server1] B -->|tcp_456|
-->|tcp_456| D[Server2] D[Server2]
</div> </div>
</body> </body>
</html> </html>
``` ```
@ -156,19 +156,19 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file,
```html ```html
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
</head> </head>
<body> <body>
<div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div> <div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div>
<div class="mermaid"> <div class="mermaid">
graph TD A[Client] --> B[Load Balancer] B --> C[Server1] B --> D[Server2] graph TD A[Client] --> B[Load Balancer] B --> C[Server1] B --> D[Server2]
</div> </div>
<script src="The\Path\In\Your\Package\mermaid.js"></script> <script src="The\Path\In\Your\Package\mermaid.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
</body> </body>
</html> </html>
``` ```
@ -189,4 +189,4 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file,
**Comments from Knut Sveidqvist, creator of mermaid:** **Comments from Knut Sveidqvist, creator of mermaid:**
- In early versions of mermaid, the `<script src>` tag was invoked in the `<head>` part of the web page. Nowadays we can place it in the `<body>` as seen above. Older parts of the documentation frequently reflects the previous way which still works. - In early versions of mermaid, the `<script src>` tag was invoked in the `<head>` part of the web page. Nowadays we can place it in the `<body>` as seen above. Older parts of the documentation frequently reflects the previous way which still works.

10
docs/n00b-overview.md
View File

@ -28,7 +28,7 @@ It is a relatively straightforward solution to a significant hurdle with the sof
```html ```html
<div class="mermaid"> <div class="mermaid">
graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02] graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02]
</div> </div>
``` ```
@ -42,10 +42,10 @@ It is a relatively straightforward solution to a significant hurdle with the sof
## Advantages of using Mermaid ## Advantages of using Mermaid
- Ease to generate, modify and render diagrams when you make them. - Ease to generate, modify and render diagrams when you make them.
- The number of integrations and plugins it has. - The number of integrations and plugins it has.
- You can add it to your or companies website. - You can add it to your or companies website.
- Diagrams can be created through comments like this in a script: - Diagrams can be created through comments like this in a script:
## The catch-22 of Diagrams and Charts: ## The catch-22 of Diagrams and Charts:

26
docs/newDiagram.md
View File

@ -10,8 +10,8 @@ This would be to define a jison grammar for the new diagram type. That should st
For instance: For instance:
- the flowchart starts with the keyword graph. - the flowchart starts with the keyword graph.
- the sequence diagram starts with the keyword sequenceDiagram - the sequence diagram starts with the keyword sequenceDiagram
#### Store data found during parsing #### Store data found during parsing
@ -38,7 +38,7 @@ The `yy` object has the following function:
```javascript ```javascript
exports.parseError = function (err, hash) { exports.parseError = function (err, hash) {
mermaid.parseError(err, hash); mermaid.parseError(err, hash);
}; };
``` ```
@ -110,10 +110,10 @@ If you are using a dagre based layout, please use flowchart-v2 as a template and
There are a few features that are common between the different types of diagrams. We try to standardize the diagrams that work as similar as possible for the end user. The commonalities are: There are a few features that are common between the different types of diagrams. We try to standardize the diagrams that work as similar as possible for the end user. The commonalities are:
- Directives, a way of modifying the diagram configuration from within the diagram code. - Directives, a way of modifying the diagram configuration from within the diagram code.
- Accessibility, a way for an author to provide additional information like titles and descriptions to people accessing a text with diagrams using a screen reader. - Accessibility, a way for an author to provide additional information like titles and descriptions to people accessing a text with diagrams using a screen reader.
- Themes, there is a common way to modify the styling of diagrams in Mermaid. - Themes, there is a common way to modify the styling of diagrams in Mermaid.
- Comments should follow mermaid standards - Comments should follow mermaid standards
Here some pointers on how to handle these different areas. Here some pointers on how to handle these different areas.
@ -236,7 +236,7 @@ This function will in turn call a function _your diagram should provide_ returni
```js ```js
const getStyles = (options) => const getStyles = (options) =>
` `
.line { .line {
stroke-width: 1; stroke-width: 1;
stroke: ${options.lineColor}; stroke: ${options.lineColor};
@ -250,11 +250,11 @@ Note that you need to provide your function to the main getStyles by adding it i
```js ```js
const themes = { const themes = {
flowchart, flowchart,
'flowchart-v2': flowchart, 'flowchart-v2': flowchart,
sequence, sequence,
xyzDiagram, xyzDiagram,
//... //...
}; };
``` ```

14
docs/pie.md
View File

@ -25,13 +25,13 @@ pie title Pets adopted by volunteers
Drawing a pie chart is really simple in mermaid. Drawing a pie chart is really simple in mermaid.
- Start with `pie` keyword to begin the diagram - Start with `pie` keyword to begin the diagram
- `showData` to render the actual data values after the legend text. This is **_OPTIONAL_** - `showData` to render the actual data values after the legend text. This is **_OPTIONAL_**
- Followed by `title` keyword and its value in string to give a title to the pie-chart. This is **_OPTIONAL_** - Followed by `title` keyword and its value in string to give a title to the pie-chart. This is **_OPTIONAL_**
- Followed by dataSet - Followed by dataSet
- `label` for a section in the pie diagram within `" "` quotes. - `label` for a section in the pie diagram within `" "` quotes.
- Followed by `:` colon as separator - Followed by `:` colon as separator
- Followed by `positive numeric value` (supported upto two decimal places) - Followed by `positive numeric value` (supported upto two decimal places)
\[pie] \[showData] (OPTIONAL) \[pie] \[showData] (OPTIONAL)
\[title] \[titlevalue] (OPTIONAL) \[title] \[titlevalue] (OPTIONAL)

88
docs/sequenceDiagram.md
View File

@ -514,7 +514,7 @@ It is possible to get a sequence number attached to each arrow in a sequence dia
```html ```html
<script> <script>
mermaid.initialize({ sequence: { showSequenceNumbers: true } }); mermaid.initialize({ sequence: { showSequenceNumbers: true } });
</script> </script>
``` ```
@ -624,81 +624,81 @@ Styling of a sequence diagram is done by defining a number of css classes. Durin
```css ```css
body { body {
background: white; background: white;
} }
.actor { .actor {
stroke: #ccccff; stroke: #ccccff;
fill: #ececff; fill: #ececff;
} }
text.actor { text.actor {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: Helvetica; font-family: Helvetica;
} }
.actor-line { .actor-line {
stroke: grey; stroke: grey;
} }
.messageLine0 { .messageLine0 {
stroke-width: 1.5; stroke-width: 1.5;
stroke-dasharray: '2 2'; stroke-dasharray: '2 2';
marker-end: 'url(#arrowhead)'; marker-end: 'url(#arrowhead)';
stroke: black; stroke: black;
} }
.messageLine1 { .messageLine1 {
stroke-width: 1.5; stroke-width: 1.5;
stroke-dasharray: '2 2'; stroke-dasharray: '2 2';
stroke: black; stroke: black;
} }
#arrowhead { #arrowhead {
fill: black; fill: black;
} }
.messageText { .messageText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
font-size: 14px; font-size: 14px;
} }
.labelBox { .labelBox {
stroke: #ccccff; stroke: #ccccff;
fill: #ececff; fill: #ececff;
} }
.labelText { .labelText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
} }
.loopText { .loopText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
} }
.loopLine { .loopLine {
stroke-width: 2; stroke-width: 2;
stroke-dasharray: '2 2'; stroke-dasharray: '2 2';
marker-end: 'url(#arrowhead)'; marker-end: 'url(#arrowhead)';
stroke: #ccccff; stroke: #ccccff;
} }
.note { .note {
stroke: #decc93; stroke: #decc93;
fill: #fff5ad; fill: #fff5ad;
} }
.noteText { .noteText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
font-size: 14px; font-size: 14px;
} }
``` ```
@ -712,12 +712,12 @@ How to use the CLI is described in the [mermaidCLI](mermaidCLI) page.
```javascript ```javascript
mermaid.sequenceConfig = { mermaid.sequenceConfig = {
diagramMarginX: 50, diagramMarginX: 50,
diagramMarginY: 10, diagramMarginY: 10,
boxTextMargin: 5, boxTextMargin: 5,
noteMargin: 10, noteMargin: 10,
messageMargin: 35, messageMargin: 35,
mirrorActors: true, mirrorActors: true,
}; };
``` ```

828
docs/theme.css
View File

File diff suppressed because one or more lines are too long

1653
docs/theme_themed.css
View File

File diff suppressed because one or more lines are too long

10
docs/theming.md
View File

@ -30,8 +30,8 @@ Example of `Initialize` call setting `theme` to `base`:
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
securityLevel: 'loose', securityLevel: 'loose',
theme: 'base', theme: 'base',
}); });
``` ```
@ -276,9 +276,9 @@ Variables that are unique to some diagrams can be affected by changes in Theme V
\*\*This got a bit too dark and bit too colorful. With some easy steps this can be fixed: \*\*This got a bit too dark and bit too colorful. With some easy steps this can be fixed:
- Make the primary color a little lighter - Make the primary color a little lighter
- set the tertiary color to a reddish shade as well - set the tertiary color to a reddish shade as well
- make the edge label background differ from the subgraph by setting the edgeLabelBackground - make the edge label background differ from the subgraph by setting the edgeLabelBackground
```mermaid-example ```mermaid-example
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%% %%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%%

4
docs/upgrading.md
View File

@ -14,7 +14,7 @@ Some of the interfaces has been upgraded.
```javascript ```javascript
mermaid_config = { mermaid_config = {
startOnLoad: true, startOnLoad: true,
}; };
``` ```
@ -22,6 +22,6 @@ mermaid_config = {
```javascript ```javascript
mermaid.initialize({ mermaid.initialize({
startOnLoad: true, startOnLoad: true,
}); });
``` ```

114
docs/usage.md
View File

@ -51,7 +51,7 @@ The easiest way to integrate mermaid on a web page requires three elements:
```html ```html
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
``` ```
@ -68,16 +68,16 @@ locate the graph definitions inside the `div` tags with `class="mermaid"` and re
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
</head> </head>
<body> <body>
<div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div> <div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
</body> </body>
</html> </html>
``` ```
@ -103,10 +103,10 @@ A `securityLevel` configuration has to first be cleared, `securityLevel` sets th
Values: Values:
- **strict**: (**default**) tags in text are encoded, click functionality is disabled - **strict**: (**default**) tags in text are encoded, click functionality is disabled
- **loose**: tags in text are allowed, click functionality is enabled - **loose**: tags in text are allowed, click functionality is enabled
- **antiscript**: html tags in text are allowed, (only script element is removed), click functionality is enabled - **antiscript**: html tags in text are allowed, (only script element is removed), click functionality is enabled
- **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This prevent any JavaScript running in the context. This may hinder interactive functionality of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. - **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This prevent any JavaScript running in the context. This may hinder interactive functionality of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc.
```note ```note
This changes the default behaviour of mermaid so that after upgrade to 8.2, unless the `securityLevel` is not changed, tags in flowcharts are encoded as tags and clicking is disabled. This changes the default behaviour of mermaid so that after upgrade to 8.2, unless the `securityLevel` is not changed, tags in flowcharts are encoded as tags and clicking is disabled.
@ -119,7 +119,7 @@ This changes the default behaviour of mermaid so that after upgrade to 8.2, unle
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
securityLevel: 'loose', securityLevel: 'loose',
}); });
``` ```
@ -130,7 +130,7 @@ whole page to load (dom + assets, particularly the fonts file).
```javascript ```javascript
$(document).load(function () { $(document).load(function () {
mermaid.initialize(); mermaid.initialize();
}); });
``` ```
@ -138,7 +138,7 @@ or
```javascript ```javascript
$(document).ready(function () { $(document).ready(function () {
mermaid.initialize(); mermaid.initialize();
}); });
``` ```
@ -148,7 +148,7 @@ If your page has other fonts in its body those might be used instead of the merm
```css ```css
div.mermaid { div.mermaid {
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
} }
``` ```
@ -158,11 +158,11 @@ By default, `mermaid.init` will be called when the document is ready, finding al
`class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need `class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need
finer-grained control of this behavior, you can call `init` yourself with: finer-grained control of this behavior, you can call `init` yourself with:
- a configuration object - a configuration object
- some nodes, as - some nodes, as
- a node - a node
- an array-like of nodes - an array-like of nodes
- or W3C selector that will find your nodes - or W3C selector that will find your nodes
Example: Example:
@ -196,16 +196,16 @@ The example below show an outline of how this could be used. The example just lo
<script src="mermaid.js"></script> <script src="mermaid.js"></script>
<script> <script>
mermaid.mermaidAPI.initialize({ startOnLoad: false }); mermaid.mermaidAPI.initialize({ startOnLoad: false });
$(function () { $(function () {
// Example of using the API var // Example of using the API var
element = document.querySelector('#graphDiv'); element = document.querySelector('#graphDiv');
var insertSvg = function (svgCode, bindFunctions) { var insertSvg = function (svgCode, bindFunctions) {
element.innerHTML = svgCode; element.innerHTML = svgCode;
}; };
var graphDefinition = 'graph TB\na-->b'; var graphDefinition = 'graph TB\na-->b';
var graph = mermaid.mermaidAPI.render('graphDiv', graphDefinition, insertSvg); var graph = mermaid.mermaidAPI.render('graphDiv', graphDefinition, insertSvg);
}); });
</script> </script>
``` ```
@ -219,11 +219,11 @@ bind events to an SVG when using the API for rendering.
```javascript ```javascript
var insertSvg = function (svgCode, bindFunctions) { var insertSvg = function (svgCode, bindFunctions) {
element.innerHTML = svgCode; element.innerHTML = svgCode;
if (typeof callback !== 'undefined') { if (typeof callback !== 'undefined') {
callback(id); callback(id);
} }
bindFunctions(element); bindFunctions(element);
}; };
var id = 'theGraph'; var id = 'theGraph';
@ -244,11 +244,11 @@ This is the renderer used for transforming the documentation from Markdown to ht
```javascript ```javascript
var renderer = new marked.Renderer(); var renderer = new marked.Renderer();
renderer.code = function (code, language) { renderer.code = function (code, language) {
if (code.match(/^sequenceDiagram/) || code.match(/^graph/)) { if (code.match(/^sequenceDiagram/) || code.match(/^graph/)) {
return '<div class="mermaid">' + code + '</div>'; return '<div class="mermaid">' + code + '</div>';
} else { } else {
return '<pre><code>' + code + '</code></pre>'; return '<pre><code>' + code + '</code></pre>';
} }
}; };
``` ```
@ -290,15 +290,15 @@ The code-example below in meta code illustrates how this could work:
```javascript ```javascript
mermaid.parseError = function (err, hash) { mermaid.parseError = function (err, hash) {
displayErrorInGui(err); displayErrorInGui(err);
}; };
var textFieldUpdated = function () { var textFieldUpdated = function () {
var textStr = getTextFromFormField('code'); var textStr = getTextFromFormField('code');
if (mermaid.parse(textStr)) { if (mermaid.parse(textStr)) {
reRender(textStr); reRender(textStr);
} }
}; };
bindEventHandler('change', 'code', textFieldUpdated); bindEventHandler('change', 'code', textFieldUpdated);
@ -328,8 +328,8 @@ on what kind of integration you use.
```html ```html
<script src="../dist/mermaid.js"></script> <script src="../dist/mermaid.js"></script>
<script> <script>
var config = { startOnLoad: true, flowchart: { useMaxWidth: false, htmlLabels: true } }; var config = { startOnLoad: true, flowchart: { useMaxWidth: false, htmlLabels: true } };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
``` ```
@ -344,8 +344,8 @@ This is the preferred way of configuring mermaid.
Is it possible to set some configuration via the mermaid object. The two parameters that are supported using this Is it possible to set some configuration via the mermaid object. The two parameters that are supported using this
approach are: approach are:
- mermaid.startOnLoad - mermaid.startOnLoad
- mermaid.htmlLabels - mermaid.htmlLabels
```javascript ```javascript
mermaid.startOnLoad = true; mermaid.startOnLoad = true;
@ -360,8 +360,8 @@ This way of setting the configuration is deprecated. Instead the preferred way i
It is possible to set some configuration via the mermaid object. The two parameters that are supported using this It is possible to set some configuration via the mermaid object. The two parameters that are supported using this
approach are: approach are:
- mermaid_config.startOnLoad - mermaid_config.startOnLoad
- mermaid_config.htmlLabels - mermaid_config.htmlLabels
```javascript ```javascript
mermaid_config.startOnLoad = true; mermaid_config.startOnLoad = true;
@ -375,8 +375,8 @@ This way of setting the configuration is deprecated. Instead the preferred way i
To set some configuration via the mermaid object. The two parameters that are supported using this approach are: To set some configuration via the mermaid object. The two parameters that are supported using this approach are:
- mermaid_config.startOnLoad - mermaid_config.startOnLoad
- mermaid_config.htmlLabels - mermaid_config.htmlLabels
```javascript ```javascript
mermaid_config.startOnLoad = true; mermaid_config.startOnLoad = true;

2
package.json
View File

@ -32,7 +32,7 @@
"build:watch": "yarn build:dev --watch", "build:watch": "yarn build:dev --watch",
"release": "yarn build", "release": "yarn build",
"lint": "eslint --cache --ignore-path .gitignore .; prettier --check .", "lint": "eslint --cache --ignore-path .gitignore .; prettier --check .",
"lint:fix": "eslint --cache --fix --ignore-path .gitignore .; prettier --write .", "lint:fix": "eslint --fix --ignore-path .gitignore .; prettier --write ./src",
"e2e:depr": "yarn lint && jest e2e --config e2e/jest.config.js", "e2e:depr": "yarn lint && jest e2e --config e2e/jest.config.js",
"cypress": "cypress run", "cypress": "cypress run",
"cypress:open": "cypress open", "cypress:open": "cypress open",

85
src/dagre-wrapper/GraphObjects.md
View File

@ -16,6 +16,7 @@ flowchart
``` ```
In this case the dagre-wrapper will transform the graph to the graph below. In this case the dagre-wrapper will transform the graph to the graph below.
```mermaid ```mermaid
flowchart flowchart
C1 --> C2 C1 --> C2
@ -28,7 +29,8 @@ When rendering this diagram it it beeing rendered recursively. The diagram is re
``` ```
{ clusterNode: true, graph } { clusterNode: true, graph }
``` ```
*Data for a clusterNode*
_Data for a clusterNode_
When a cluster has edges to or from some of its nodes leading outside the cluster the approach of recursive rendering can not be used as the layout of the graph needs to take responsibility for nodes outside of the cluster. When a cluster has edges to or from some of its nodes leading outside the cluster the approach of recursive rendering can not be used as the layout of the graph needs to take responsibility for nodes outside of the cluster.
@ -49,7 +51,6 @@ In the diagram above the root diagram would be rendered with C1 whereas C2 would
Of these two approaches the top one renders better and is used when possible. When this is not possible, ie an edge is added crossing the border the non recursive approach is used. Of these two approaches the top one renders better and is used when possible. When this is not possible, ie an edge is added crossing the border the non recursive approach is used.
# Graph objects and their properties # Graph objects and their properties
Explains the representation of various objects used to render the flow charts and what the properties mean. This ofc from the perspective of the dagre-wrapper. Explains the representation of various objects used to render the flow charts and what the properties mean. This ofc from the perspective of the dagre-wrapper.
@ -57,35 +58,36 @@ Explains the representation of various objects used to render the flow charts an
## node ## node
Sample object: Sample object:
```json ```json
{ {
"shape":"rect", "shape": "rect",
"labelText":"Test", "labelText": "Test",
"rx":0, "rx": 0,
"ry":0, "ry": 0,
"class":"default", "class": "default",
"style":"", "style": "",
"id":"Test", "id": "Test",
"type":"group", "type": "group",
"padding":15} "padding": 15
}
``` ```
This is set by the renderer of the diagram and insert the data that the wrapper neds for rendering. This is set by the renderer of the diagram and insert the data that the wrapper neds for rendering.
| property | description | | property | description |
| ---------- | ----------------------------------------------------------------------------------------------------------- | | ---------- | ------------------------------------------------------------------------------------------------ |
| labelStyle | Css styles for the label. User for instance for styling the labels for clusters | | labelStyle | Css styles for the label. User for instance for styling the labels for clusters |
| shape | The shape of the node. | | shape | The shape of the node. |
| labelText | The text on the label | | labelText | The text on the label |
| rx | The corner radius - maybe part of the shape instead? Used for rects. | | rx | The corner radius - maybe part of the shape instead? Used for rects. |
| ry | The corner radius - maybe part of the shape instead? Used for rects. | | ry | The corner radius - maybe part of the shape instead? Used for rects. |
| classes | Classes to be set for the shape. Not used | | classes | Classes to be set for the shape. Not used |
| style | Css styles for the actual shape | | style | Css styles for the actual shape |
| id | id of the shape | | id | id of the shape |
| type | if set to group then this node indicates *a cluster*. | | type | if set to group then this node indicates _a cluster_. |
| padding | Padding. Passed from the render as this might differ between different diagrams. Maybe obsolete. | | padding | Padding. Passed from the render as this might differ between different diagrams. Maybe obsolete. |
| data | Non-generic data specific to the shape. | | data | Non-generic data specific to the shape. |
# edge # edge
@ -100,22 +102,20 @@ double_arrow_circle
Lets try to make these types semantic free so that diagram type semantics does not find its way in to this more generic layer. Lets try to make these types semantic free so that diagram type semantics does not find its way in to this more generic layer.
Required edgeData for proper rendering: Required edgeData for proper rendering:
| property | description | | property | description |
| ---------- | ---------------------------------------- | | ---------- | -------------------------------------------------------------------- |
| id | Id of the edge | | id | Id of the edge |
| arrowHead | overlap between arrowHead and arrowType? | | arrowHead | overlap between arrowHead and arrowType? |
| arrowType | overlap between arrowHead and arrowType? | | arrowType | overlap between arrowHead and arrowType? |
| style | | | style | |
| labelStyle | | | labelStyle | |
| label | overlap between label and labelText? | | label | overlap between label and labelText? |
| labelPos | | | labelPos | |
| labelType | overlap between label and labelText? | | labelType | overlap between label and labelText? |
| thickness | Sets the thinkess of the edge. Can be \['normal', 'thick'\] | | thickness | Sets the thinkess of the edge. Can be \['normal', 'thick'\] |
| pattern | Sets the pattern of the edge. Can be \['solid', 'dotted', 'dashed'\] | | pattern | Sets the pattern of the edge. Can be \['solid', 'dotted', 'dashed'\] |
# Markers # Markers
@ -127,12 +127,13 @@ insertMarkers(el, \['point', 'circle'\])
The example above adds the markers point and cross. This means that edges with the arrowTypes arrow_cross, double_arrow_cross, arrow_point and double_arrow_cross will get the corresponding markers but arrowType arrow_cross will have no impact. The example above adds the markers point and cross. This means that edges with the arrowTypes arrow_cross, double_arrow_cross, arrow_point and double_arrow_cross will get the corresponding markers but arrowType arrow_cross will have no impact.
Current markers: Current markers:
* point - the standard arrow from flowcharts
* circle - Arrows ending with circle
* cross - arrows starting and ending with a cross
- point - the standard arrow from flowcharts
- circle - Arrows ending with circle
- cross - arrows starting and ending with a cross
// Todo - in case of common renderer // Todo - in case of common renderer
# Common functions used by the renderer to be implemented by the Db # Common functions used by the renderer to be implemented by the Db
getDirection getDirection

2
src/dagre-wrapper/edges.js
View File

@ -240,7 +240,7 @@ export const intersection = (node, outsidePoint, insidePoint) => {
const Q = Math.abs(outsidePoint.y - insidePoint.y); const Q = Math.abs(outsidePoint.y - insidePoint.y);
const R = Math.abs(outsidePoint.x - insidePoint.x); const R = Math.abs(outsidePoint.x - insidePoint.x);
// log.warn(); // log.warn();
if (Math.abs(y - outsidePoint.y) * w > Math.abs(x - outsidePoint.x) * h) { // eslint-disable-line if (Math.abs(y - outsidePoint.y) * w > Math.abs(x - outsidePoint.x) * h) {
// Intersection is top or bottom of rect. // Intersection is top or bottom of rect.
// let q = insidePoint.y < outsidePoint.y ? outsidePoint.y - h - y : y - h - outsidePoint.y; // let q = insidePoint.y < outsidePoint.y ? outsidePoint.y - h - y : y - h - outsidePoint.y;
let q = insidePoint.y < outsidePoint.y ? outsidePoint.y - h - y : y - h - outsidePoint.y; let q = insidePoint.y < outsidePoint.y ? outsidePoint.y - h - y : y - h - outsidePoint.y;

13
src/diagrams/flowchart/flowChartShapes.spec.js
View File

@ -94,6 +94,9 @@ describe('flowchart shapes', function () {
}); });
}); });
/**
*
*/
function MockRender() { function MockRender() {
const shapes = {}; const shapes = {};
return { return {
@ -103,6 +106,11 @@ function MockRender() {
}; };
} }
/**
*
* @param tag
* @param {...any} args
*/
function MockSvg(tag, ...args) { function MockSvg(tag, ...args) {
const children = []; const children = [];
const attributes = {}; const attributes = {};
@ -139,6 +147,11 @@ function useWidth(w, h) {
return w; return w;
} }
/**
*
* @param w
* @param h
*/
function useHeight(w, h) { function useHeight(w, h) {
return h; return h;
} }

3
src/diagrams/git/gitGraphAst.js
View File

@ -24,6 +24,9 @@ let curBranch = mainBranchName;
let direction = 'LR'; let direction = 'LR';
let seq = 0; let seq = 0;
/**
*
*/
function getId() { function getId() {
// eslint-disable-line // eslint-disable-line
return random({ length: 7 }); return random({ length: 7 });

2
src/diagrams/git/layout.js
View File

@ -1,6 +1,6 @@
import { getConfig } from '../../config'; import { getConfig } from '../../config';
export default (dir, _branches, _commits) => { // eslint-disable-line export default (dir, _branches, _commits) => {
const config = getConfig().gitGraph; const config = getConfig().gitGraph;
const branches = []; const branches = [];
const commits = []; const commits = [];

5
src/diagrams/sequence/svgDraw.js
View File

@ -918,7 +918,7 @@ const _drawTextCandidateFunc = (function () {
*/ */
function _setTextAttrs(toText, fromTextAttrsDict) { function _setTextAttrs(toText, fromTextAttrsDict) {
for (const key in fromTextAttrsDict) { for (const key in fromTextAttrsDict) {
if (fromTextAttrsDict.hasOwnProperty(key)) { // eslint-disable-line if (fromTextAttrsDict.hasOwnProperty(key)) {
toText.attr(key, fromTextAttrsDict[key]); toText.attr(key, fromTextAttrsDict[key]);
} }
} }
@ -1026,7 +1026,8 @@ const _drawMenuItemTextCandidateFunc = (function () {
*/ */
function _setTextAttrs(toText, fromTextAttrsDict) { function _setTextAttrs(toText, fromTextAttrsDict) {
for (const key in fromTextAttrsDict) { for (const key in fromTextAttrsDict) {
if (fromTextAttrsDict.hasOwnProperty(key)) { // eslint-disable-line if (fromTextAttrsDict.hasOwnProperty(key)) {
// eslint-disable-line
toText.attr(key, fromTextAttrsDict[key]); toText.attr(key, fromTextAttrsDict[key]);
} }
} }

2
src/docs.mts
View File

@ -53,7 +53,7 @@ const transform = (file: string) => {
prettier.format(transformed, { prettier.format(transformed, {
parser: 'markdown', parser: 'markdown',
useTabs: false, useTabs: false,
tabWidth: 4, tabWidth: 2,
endOfLine: 'auto', endOfLine: 'auto',
printWidth: 100, printWidth: 100,
singleQuote: true, singleQuote: true,

89
src/docs/8.6.0_docs.md
View File

@ -15,19 +15,19 @@ the `init` directive is the main method of configuration for Site and Current Le
The three levels of are Configuration, Global, Site and Current. The three levels of are Configuration, Global, Site and Current.
| Level of Configuration | Description | | Level of Configuration | Description |
| --- | --- | | ---------------------- | ----------------------------------- |
| Global Configuration| Default Mermaid Configurations| | Global Configuration | Default Mermaid Configurations |
| Site Configuration| Configurations made by site owner| | Site Configuration | Configurations made by site owner |
| Current Configuration| Configurations made by Implementors| | Current Configuration | Configurations made by Implementors |
# Limits to Modifying Configurations # Limits to Modifying Configurations
**secure Array** **secure Array**
| Parameter | Description |Type | Required | Values| | Parameter | Description | Type | Required | Values |
| --- | --- | --- | --- | --- | | --------- | ------------------------------------------------ | ----- | -------- | -------------- |
| secure | Array of parameters excluded from init directive| Array | Required | Any parameters| | secure | Array of parameters excluded from init directive | Array | Required | Any parameters |
The modifiable parts of the Configuration are limited by the secure array, which is an array of immutable parameters, this array can be expanded by site owners. The modifiable parts of the Configuration are limited by the secure array, which is an array of immutable parameters, this array can be expanded by site owners.
@ -43,6 +43,7 @@ Default values for the `secure array` consists of: ['secure', 'securityLevel', '
Implementors can only modify configurations using directives, and cannot change the `secure` array. Implementors can only modify configurations using directives, and cannot change the `secure` array.
# Modifying Configurations and directives: # Modifying Configurations and directives:
The Two types of directives: are `init` (or `initialize`) and `wrap`. The Two types of directives: are `init` (or `initialize`) and `wrap`.
```note ```note
@ -52,12 +53,12 @@ All directives are enclosed in `%%{ }%%`
Older versions of mermaid will not parse directives because `%%` will comment out the directive. This makes the update backwards-compatible. Older versions of mermaid will not parse directives because `%%` will comment out the directive. This makes the update backwards-compatible.
# Init # Init
`init`, or `initialize`: this directive gives the user the ability to overwrite and change the values for any configuration parameters not set in the secure array. `init`, or `initialize`: this directive gives the user the ability to overwrite and change the values for any configuration parameters not set in the secure array.
| Parameter | Description |Type | Required | Values| | Parameter | Description | Type | Required | Values |
| --- | --- | --- | --- | --- | | --------- | ----------------------- | --------- | -------- | ----------------------------------------------- |
| init | modifies configurations| Directive| Optional | Any parameters not included in the secure array| | init | modifies configurations | Directive | Optional | Any parameters not included in the secure array |
```note ```note
init would be an argument-directive: `%%{init: { **insert argument here**}}%%` init would be an argument-directive: `%%{init: { **insert argument here**}}%%`
@ -73,6 +74,7 @@ When deployed within code, init is called before the graph/diagram description.
``` ```
**for example**: **for example**:
```mmd ```mmd
%%{init: {"theme": "default", "logLevel": 1 }}%% %%{init: {"theme": "default", "logLevel": 1 }}%%
graph LR graph LR
@ -84,11 +86,12 @@ When deployed within code, init is called before the graph/diagram description.
f-->g f-->g
g--> g-->
``` ```
# Wrap # Wrap
| Parameter | Description |Type | Required | Values| | Parameter | Description | Type | Required | Values |
| --- | --- | --- | --- | --- | | --------- | ----------------------------- | --------- | -------- | ---------- |
| wrap | a callable text-wrap function| Directive| Optional | %%{wrap}%%| | wrap | a callable text-wrap function | Directive | Optional | %%{wrap}%% |
```note ```note
Wrap is a function that is currently only deployable for sequence diagrams. Wrap is a function that is currently only deployable for sequence diagrams.
@ -104,8 +107,8 @@ It is a non-argument directive and can be executed thusly:
![Image showing wrapped text](img/wrapped%20text.png) ![Image showing wrapped text](img/wrapped%20text.png)
# Resetting Configurations: # Resetting Configurations:
There are two more functions in the mermaidAPI that can be called by site owners: **reset** and **globalReset**. There are two more functions in the mermaidAPI that can be called by site owners: **reset** and **globalReset**.
**reset**: resets the configuration to whatever the last configuration was. This can be done to undo more recent changes set from the last mermaidAPI.initialize({...}) configuration. **reset**: resets the configuration to whatever the last configuration was. This can be done to undo more recent changes set from the last mermaidAPI.initialize({...}) configuration.
@ -115,31 +118,30 @@ There are two more functions in the mermaidAPI that can be called by site owners
**Notes**: Both `reset` and `globalReset` are only available to site owners, and as such implementors have to edit their configs using `init`. **Notes**: Both `reset` and `globalReset` are only available to site owners, and as such implementors have to edit their configs using `init`.
# Additional Utils to mermaid # Additional Utils to mermaid
• **memoize**: simple caching for computationally expensive functions, reducing rendering time by about 90%.
• **assignWithDepth** - an improvement on previous functions with config.js and `Object.assign`. The purpose of this function is to provide a sane mechanism for merging objects, similar to `object.assign`, but with depth. • **memoize**: simple caching for computationally expensive functions, reducing rendering time by about 90%.
• **assignWithDepth** - an improvement on previous functions with config.js and `Object.assign`. The purpose of this function is to provide a sane mechanism for merging objects, similar to `object.assign`, but with depth.
Example of **assignWithDepth**: Example of **assignWithDepth**:
![Image showing assignWithDepth](img/assignWithDepth.png) ![Image showing assignWithDepth](img/assignWithDepth.png)
Example of **object.Assign**: Example of **object.Assign**:
![Image showing object.assign without depth](img/object.assign%20without%20depth.png) ![Image showing object.assign without depth](img/object.assign%20without%20depth.png)
• **calculateTextDimensions**, **calculateTextWidth**， and **calculateTextHeight** - for measuring text dimensions, width and height. • **calculateTextDimensions**, **calculateTextWidth**， and **calculateTextHeight** - for measuring text dimensions, width and height.
**Notes**: For more information on usage, parameters, and return info for these new functions take a look at the jsdocs for them in the utils package. **Notes**: For more information on usage, parameters, and return info for these new functions take a look at the jsdocs for them in the utils package.
# New API Requests Introduced in Version 8.6.0 # New API Requests Introduced in Version 8.6.0
## setSiteConfig ## setSiteConfig
| Function | Description | Type | Values |Parameters|Returns| | Function | Description | Type | Values | Parameters | Returns |
| --------- | ------------------- | ------- | ------------------ | ------------------ | ------------------ | | --------------- | ------------------------------------- | ----------- | --------------------------------------- | ---------- | ---------- |
| `setSiteConfig`|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array|conf|siteConfig| | `setSiteConfig` | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array | conf | siteConfig |
```note ```note
Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset
@ -151,9 +153,9 @@ Default value: will mirror Global Config
## getSiteConfig ## getSiteConfig
| Function | Description | Type | Values | | Function | Description | Type | Values |
| --------- | ------------------- | ------- | ------------------ | | --------------- | --------------------------------------------------- | ----------- | ---------------------------------- |
| `getSiteConfig`|Returns the current `siteConfig` base configuration | Get Request | Returns Any Values in `siteConfig`| | `getSiteConfig` | Returns the current `siteConfig` base configuration | Get Request | Returns Any Values in `siteConfig` |
```note ```note
Returns any values in siteConfig. Returns any values in siteConfig.
@ -161,9 +163,9 @@ Returns any values in siteConfig.
## setConfig ## setConfig
| Function | Description | Type | Values |Parameters|Returns| | Function | Description | Type | Values | Parameters | Returns |
| --------- | ------------------- | ------- | ------------------ |----------|-------| | ----------- | ------------------------------------------ | ----------- | --------------------------------- | ---------- | ---------------------------------------------- |
| `setConfig`|Sets the `currentConfig` to desired values | Put Request| Any Values, those in secure array|conf|`currentConfig` merged with the sanitized conf| | `setConfig` | Sets the `currentConfig` to desired values | Put Request | Any Values, those in secure array | conf | `currentConfig` merged with the sanitized conf |
```note ```note
Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure keys. Any Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure keys. Any
@ -173,10 +175,9 @@ siteConfig value.
## getConfig ## getConfig
| Function | Description | Type | Return Values | | Function | Description | Type | Return Values |
| --------- | ------------------- | ------- | ------------------ | | ----------- | --------------------------- | ----------- | ------------------------------- |
| `getConfig` |Obtains the `currentConfig` | Get Request | Any Values from `currentConfig`| | `getConfig` | Obtains the `currentConfig` | Get Request | Any Values from `currentConfig` |
```note ```note
Returns any values in currentConfig. Returns any values in currentConfig.
@ -184,9 +185,9 @@ Returns any values in currentConfig.
## sanitize ## sanitize
| Function | Description | Type | Values | | Function | Description | Type | Values |
| --------- | ------------------- | ------- | ------------------ | | ---------- | ---------------------------------------- | -------------- | ------ |
| `sanitize` |Sets the `siteConfig` to desired values. | Put Request(?) |None| | `sanitize` | Sets the `siteConfig` to desired values. | Put Request(?) | None |
```note ```note
modifies options in-place modifies options in-place
@ -195,15 +196,15 @@ Ensures options parameter does not attempt to override siteConfig secure keys.
## reset ## reset
| Function | Description | Type | Required | Values |Parameter| | Function | Description | Type | Required | Values | Parameter |
| --------- | -------------------| ------- | -------- | ------------------ |---------| | -------- | ------------------------------ | ----------- | -------- | ------ | --------- |
| `reset`|Resets `currentConfig` to conf| Put Request | Required | None| conf| | `reset` | Resets `currentConfig` to conf | Put Request | Required | None | conf |
## conf ## conf
| Parameter | Description |Type | Required | Values| | Parameter | Description | Type | Required | Values |
| --- | --- | --- | --- | --- | | --------- | ------------------------------------------------------------ | ---------- | -------- | -------------------------------------------- |
| `conf`| base set of values, which `currentConfig` could be reset to.| Dictionary | Required | Any Values, with respect to the secure Array| | `conf` | base set of values, which `currentConfig` could be reset to. | Dictionary | Required | Any Values, with respect to the secure Array |
```note ```note
default: current siteConfig (optional, default `getSiteConfig()`) default: current siteConfig (optional, default `getSiteConfig()`)

95
src/docs/CHANGELOG.md
View File

@ -26,7 +26,8 @@ Example of `Initalize` call setting `theme` to `base`:
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
'securityLevel': 'loose', 'theme': 'base' securityLevel: 'loose',
theme: 'base',
}); });
``` ```
@ -49,11 +50,10 @@ It is also possible to override site-wide theme settings locally, for a specific
The easiest way to make a custom theme is to start with the base theme, and just modify theme variables through `themeVariables`, via `%%init%%`. The easiest way to make a custom theme is to start with the base theme, and just modify theme variables through `themeVariables`, via `%%init%%`.
| Parameter | Description | Type | Required | Objects contained | | Parameter | Description | Type | Required | Objects contained |
| -------------- | ------------------------------------------------------------------ | ----- | -------- | ---------------------------------- | | -------------- | ------------------------------------------------------------------ | ----- | -------- | ---------------------------------- |
| themeVariables | Array containing objects, modifiable with the `%%init%%` directive | Array | Required | primaryColor, lineColor, textColor | | themeVariables | Array containing objects, modifiable with the `%%init%%` directive | Array | Required | primaryColor, lineColor, textColor |
Here is an example of overriding `primaryColor` and giving everything a different look, using `%%init%%`. Here is an example of overriding `primaryColor` and giving everything a different look, using `%%init%%`.
```mmd ```mmd
@ -117,9 +117,9 @@ This was introduced in version 8.2 as a security improvement, aimed at preventin
**Notes:** **Notes:**
- **strict**: (**default**) tags in text are encoded, click functionality is disabled - **strict**: (**default**) tags in text are encoded, click functionality is disabled
- **loose**: tags in text are allowed, click functionality is enabled - **loose**: tags in text are allowed, click functionality is enabled
- **antiscript**: html tags in text are allowed, (only script element is removed), click functionality is enabled - **antiscript**: html tags in text are allowed, (only script element is removed), click functionality is enabled
⚠️ **Note**: This changes the default behaviour of mermaid so that after upgrade to 8.2, if the `securityLevel` is not configured, tags in flowcharts are encoded as tags and clicking is prohibited. ⚠️ **Note**: This changes the default behaviour of mermaid so that after upgrade to 8.2, if the `securityLevel` is not configured, tags in flowcharts are encoded as tags and clicking is prohibited.
@ -129,9 +129,9 @@ By doing this clicks and tags are again allowed.
### To change `securityLevel` with `mermaidAPI.initialize`: ### To change `securityLevel` with `mermaidAPI.initialize`:
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
securityLevel: 'loose' securityLevel: 'loose',
}); });
``` ```
**Closed issues:** **Closed issues:**
@ -160,9 +160,9 @@ By doing this clicks and tags are again allowed.
- margins around flowchart are not balanced [\#852](https://github.com/knsv/mermaid/issues/852) - margins around flowchart are not balanced [\#852](https://github.com/knsv/mermaid/issues/852)
- Smaller bundles [\#843](https://github.com/knsv/mermaid/issues/843) - Smaller bundles [\#843](https://github.com/knsv/mermaid/issues/843)
- unicode in labels [\#776](https://github.com/knsv/mermaid/issues/776) - unicode in labels [\#776](https://github.com/knsv/mermaid/issues/776)
- Hard-changing drawing of arrows per edge type [\#775](https://github.com/knsv/mermaid/issues/775) - Hard-changing drawing of arrows per edge type [\#775](https://github.com/knsv/mermaid/issues/775)
- SequenceDiagram wrong [\#773](https://github.com/knsv/mermaid/issues/773) - SequenceDiagram wrong [\#773](https://github.com/knsv/mermaid/issues/773)
- Render mermaid on github pages with simple code [\#772](https://github.com/knsv/mermaid/issues/772) - Render mermaid on github pages with simple code [\#772](https://github.com/knsv/mermaid/issues/772)
- FlowChart - large space between text and the image [\#754](https://github.com/knsv/mermaid/issues/754) - FlowChart - large space between text and the image [\#754](https://github.com/knsv/mermaid/issues/754)
- Class Diagram Issues when using Mermaid in Stackedit [\#748](https://github.com/knsv/mermaid/issues/748) - Class Diagram Issues when using Mermaid in Stackedit [\#748](https://github.com/knsv/mermaid/issues/748)
- Multi-platform CI [\#744](https://github.com/knsv/mermaid/issues/744) - Multi-platform CI [\#744](https://github.com/knsv/mermaid/issues/744)
@ -175,18 +175,18 @@ By doing this clicks and tags are again allowed.
- Issue on Dynamic Creation in PHP [\#690](https://github.com/knsv/mermaid/issues/690) - Issue on Dynamic Creation in PHP [\#690](https://github.com/knsv/mermaid/issues/690)
- `click "\#target"` and `click "http://url"` should create regular links [\#689](https://github.com/knsv/mermaid/issues/689) - `click "\#target"` and `click "http://url"` should create regular links [\#689](https://github.com/knsv/mermaid/issues/689)
- Support Chinese punctuation [\#687](https://github.com/knsv/mermaid/issues/687) - Support Chinese punctuation [\#687](https://github.com/knsv/mermaid/issues/687)
- \[Question\] Proper way to install on Mac? [\#681](https://github.com/knsv/mermaid/issues/681) - \[Question\] Proper way to install on Mac? [\#681](https://github.com/knsv/mermaid/issues/681)
- Has Mermaid a graphical interface to make diagrams? [\#668](https://github.com/knsv/mermaid/issues/668) - Has Mermaid a graphical interface to make diagrams? [\#668](https://github.com/knsv/mermaid/issues/668)
- mermaid installation on debian [\#649](https://github.com/knsv/mermaid/issues/649) - mermaid installation on debian [\#649](https://github.com/knsv/mermaid/issues/649)
- "Cannot activate" in sequenceDiagram [\#647](https://github.com/knsv/mermaid/issues/647) - "Cannot activate" in sequenceDiagram [\#647](https://github.com/knsv/mermaid/issues/647)
- Link \("click" statement\) in flowchart does not work in exported SVG [\#646](https://github.com/knsv/mermaid/issues/646) - Link \("click" statement\) in flowchart does not work in exported SVG [\#646](https://github.com/knsv/mermaid/issues/646)
- How to pass styling [\#639](https://github.com/knsv/mermaid/issues/639) - How to pass styling [\#639](https://github.com/knsv/mermaid/issues/639)
- The live editor cant show seq diagram with notes for 8.0.0-alpha.3 [\#638](https://github.com/knsv/mermaid/issues/638) - The live editor cant show seq diagram with notes for 8.0.0-alpha.3 [\#638](https://github.com/knsv/mermaid/issues/638)
- import mermaid.css with ES6 + NPM [\#634](https://github.com/knsv/mermaid/issues/634) - import mermaid.css with ES6 + NPM [\#634](https://github.com/knsv/mermaid/issues/634)
- Actor line cuts through other elements [\#633](https://github.com/knsv/mermaid/issues/633) - Actor line cuts through other elements [\#633](https://github.com/knsv/mermaid/issues/633)
- Graph TD line out of the picture \(left side\) [\#630](https://github.com/knsv/mermaid/issues/630) - Graph TD line out of the picture \(left side\) [\#630](https://github.com/knsv/mermaid/issues/630)
- Flowchart labels appear "cutoff" [\#628](https://github.com/knsv/mermaid/issues/628) - Flowchart labels appear "cutoff" [\#628](https://github.com/knsv/mermaid/issues/628)
- Uncaught TypeError: \_.constant is not a function \(mermaid.js\) [\#626](https://github.com/knsv/mermaid/issues/626) - Uncaught TypeError: \_.constant is not a function \(mermaid.js\) [\#626](https://github.com/knsv/mermaid/issues/626)
- Missing tags and releases for newer versions [\#623](https://github.com/knsv/mermaid/issues/623) - Missing tags and releases for newer versions [\#623](https://github.com/knsv/mermaid/issues/623)
- Mermaid and Leo / Leo Vue [\#622](https://github.com/knsv/mermaid/issues/622) - Mermaid and Leo / Leo Vue [\#622](https://github.com/knsv/mermaid/issues/622)
- mermaidAPI gantt Vue.js [\#621](https://github.com/knsv/mermaid/issues/621) - mermaidAPI gantt Vue.js [\#621](https://github.com/knsv/mermaid/issues/621)
@ -221,7 +221,7 @@ By doing this clicks and tags are again allowed.
- TypeError: Cannot read property 'select' of undefined [\#563](https://github.com/knsv/mermaid/issues/563) - TypeError: Cannot read property 'select' of undefined [\#563](https://github.com/knsv/mermaid/issues/563)
- A little bug [\#557](https://github.com/knsv/mermaid/issues/557) - A little bug [\#557](https://github.com/knsv/mermaid/issues/557)
- Japanese text appears garbled [\#554](https://github.com/knsv/mermaid/issues/554) - Japanese text appears garbled [\#554](https://github.com/knsv/mermaid/issues/554)
- classdiagram not works in mermaid live\_editor [\#553](https://github.com/knsv/mermaid/issues/553) - classdiagram not works in mermaid live_editor [\#553](https://github.com/knsv/mermaid/issues/553)
- font awesome in link text? [\#546](https://github.com/knsv/mermaid/issues/546) - font awesome in link text? [\#546](https://github.com/knsv/mermaid/issues/546)
- q: heard of the cosmogol standard? [\#545](https://github.com/knsv/mermaid/issues/545) - q: heard of the cosmogol standard? [\#545](https://github.com/knsv/mermaid/issues/545)
- Arrow heads missing \(cli, 7.0.3\) [\#544](https://github.com/knsv/mermaid/issues/544) - Arrow heads missing \(cli, 7.0.3\) [\#544](https://github.com/knsv/mermaid/issues/544)
@ -248,7 +248,7 @@ By doing this clicks and tags are again allowed.
- Flowchart edge labels placement [\#490](https://github.com/knsv/mermaid/issues/490) - Flowchart edge labels placement [\#490](https://github.com/knsv/mermaid/issues/490)
- Very different styles when rendering as png vs. svg [\#489](https://github.com/knsv/mermaid/issues/489) - Very different styles when rendering as png vs. svg [\#489](https://github.com/knsv/mermaid/issues/489)
- New editor that supports mermaid: Caret [\#488](https://github.com/knsv/mermaid/issues/488) - New editor that supports mermaid: Caret [\#488](https://github.com/knsv/mermaid/issues/488)
- Gant PNG margin [\#486](https://github.com/knsv/mermaid/issues/486) - Gant PNG margin [\#486](https://github.com/knsv/mermaid/issues/486)
- ReferenceError: window is not defined [\#485](https://github.com/knsv/mermaid/issues/485) - ReferenceError: window is not defined [\#485](https://github.com/knsv/mermaid/issues/485)
- Menu and layout bugs in docs [\#484](https://github.com/knsv/mermaid/issues/484) - Menu and layout bugs in docs [\#484](https://github.com/knsv/mermaid/issues/484)
- Mermaid resets some of the page CSS styles [\#482](https://github.com/knsv/mermaid/issues/482) - Mermaid resets some of the page CSS styles [\#482](https://github.com/knsv/mermaid/issues/482)
@ -271,7 +271,7 @@ By doing this clicks and tags are again allowed.
- shouldn't mermaid become more like Markdown ? [\#417](https://github.com/knsv/mermaid/issues/417) - shouldn't mermaid become more like Markdown ? [\#417](https://github.com/knsv/mermaid/issues/417)
- Live editor show rendered diagram if syntax invalid [\#415](https://github.com/knsv/mermaid/issues/415) - Live editor show rendered diagram if syntax invalid [\#415](https://github.com/knsv/mermaid/issues/415)
- Linkstyle stroke does not work [\#410](https://github.com/knsv/mermaid/issues/410) - Linkstyle stroke does not work [\#410](https://github.com/knsv/mermaid/issues/410)
- flowchart id's with dots in them .. break links [\#408](https://github.com/knsv/mermaid/issues/408) - flowchart id's with dots in them .. break links [\#408](https://github.com/knsv/mermaid/issues/408)
- Flowchart: Link text beginning with lowercase 'o' causes flowchart to break [\#407](https://github.com/knsv/mermaid/issues/407) - Flowchart: Link text beginning with lowercase 'o' causes flowchart to break [\#407](https://github.com/knsv/mermaid/issues/407)
- Some Chinese character will case Safari no responding. [\#405](https://github.com/knsv/mermaid/issues/405) - Some Chinese character will case Safari no responding. [\#405](https://github.com/knsv/mermaid/issues/405)
- Cannot center-justify text in nodes? [\#397](https://github.com/knsv/mermaid/issues/397) - Cannot center-justify text in nodes? [\#397](https://github.com/knsv/mermaid/issues/397)
@ -282,7 +282,7 @@ By doing this clicks and tags are again allowed.
- sequence diagram config issue [\#385](https://github.com/knsv/mermaid/issues/385) - sequence diagram config issue [\#385](https://github.com/knsv/mermaid/issues/385)
- How to add newline in the text [\#384](https://github.com/knsv/mermaid/issues/384) - How to add newline in the text [\#384](https://github.com/knsv/mermaid/issues/384)
- PhantomJS crashes on a large graph [\#380](https://github.com/knsv/mermaid/issues/380) - PhantomJS crashes on a large graph [\#380](https://github.com/knsv/mermaid/issues/380)
- Finnish support for class diagrams using plantuml syntax [\#377](https://github.com/knsv/mermaid/issues/377) - Finnish support for class diagrams using plantuml syntax [\#377](https://github.com/knsv/mermaid/issues/377)
- mermaidAPI.render generated different svg code from mermaid.int\(\) [\#374](https://github.com/knsv/mermaid/issues/374) - mermaidAPI.render generated different svg code from mermaid.int\(\) [\#374](https://github.com/knsv/mermaid/issues/374)
- Put your own action on the chart [\#372](https://github.com/knsv/mermaid/issues/372) - Put your own action on the chart [\#372](https://github.com/knsv/mermaid/issues/372)
- when declaring participants the elements are generated twice [\#370](https://github.com/knsv/mermaid/issues/370) - when declaring participants the elements are generated twice [\#370](https://github.com/knsv/mermaid/issues/370)
@ -312,7 +312,7 @@ By doing this clicks and tags are again allowed.
- Mermaid does not work in Chrome 48 [\#281](https://github.com/knsv/mermaid/issues/281) - Mermaid does not work in Chrome 48 [\#281](https://github.com/knsv/mermaid/issues/281)
- circle and ellipse cannot change color by classDef [\#271](https://github.com/knsv/mermaid/issues/271) - circle and ellipse cannot change color by classDef [\#271](https://github.com/knsv/mermaid/issues/271)
- npm run watch doesn't work due missing dependencies [\#266](https://github.com/knsv/mermaid/issues/266) - npm run watch doesn't work due missing dependencies [\#266](https://github.com/knsv/mermaid/issues/266)
- label out of node [\#262](https://github.com/knsv/mermaid/issues/262) - label out of node [\#262](https://github.com/knsv/mermaid/issues/262)
- IE11 Support issue [\#261](https://github.com/knsv/mermaid/issues/261) - IE11 Support issue [\#261](https://github.com/knsv/mermaid/issues/261)
- mermaid without browser [\#260](https://github.com/knsv/mermaid/issues/260) - mermaid without browser [\#260](https://github.com/knsv/mermaid/issues/260)
- Insufficient capacity of gantt diagrams [\#226](https://github.com/knsv/mermaid/issues/226) - Insufficient capacity of gantt diagrams [\#226](https://github.com/knsv/mermaid/issues/226)
@ -346,13 +346,14 @@ By doing this clicks and tags are again allowed.
- Adding trapezoid and inverse trapezoid vertex options. [\#741](https://github.com/knsv/mermaid/pull/741) ([adamwulf](https://github.com/adamwulf)) - Adding trapezoid and inverse trapezoid vertex options. [\#741](https://github.com/knsv/mermaid/pull/741) ([adamwulf](https://github.com/adamwulf))
- Add option for right angles [\#721](https://github.com/knsv/mermaid/pull/721) ([paulbland](https://github.com/paulbland)) - Add option for right angles [\#721](https://github.com/knsv/mermaid/pull/721) ([paulbland](https://github.com/paulbland))
- Add nested activation classes [\#720](https://github.com/knsv/mermaid/pull/720) ([paulbland](https://github.com/paulbland)) - Add nested activation classes [\#720](https://github.com/knsv/mermaid/pull/720) ([paulbland](https://github.com/paulbland))
- wip: class diagram cardinality display [\#705](https://github.com/knsv/mermaid/pull/705) ([Vrixyz](https://github.com/Vrixyz)) - wip: class diagram cardinality display [\#705](https://github.com/knsv/mermaid/pull/705) ([Vrixyz](https://github.com/Vrixyz))
- add comments about CSS in config [\#688](https://github.com/knsv/mermaid/pull/688) ([imma90](https://github.com/imma90)) - add comments about CSS in config [\#688](https://github.com/knsv/mermaid/pull/688) ([imma90](https://github.com/imma90))
- SequenceDiagram: Add support for multiple alt else statements [\#641](https://github.com/knsv/mermaid/pull/641) ([sechel](https://github.com/sechel)) - SequenceDiagram: Add support for multiple alt else statements [\#641](https://github.com/knsv/mermaid/pull/641) ([sechel](https://github.com/sechel))
- fix \#426 - add class .clickable on nodes with click function or link [\#598](https://github.com/knsv/mermaid/pull/598) ([thomasleveil](https://github.com/thomasleveil)) - fix \#426 - add class .clickable on nodes with click function or link [\#598](https://github.com/knsv/mermaid/pull/598) ([thomasleveil](https://github.com/thomasleveil))
- Spec fix 1 [\#595](https://github.com/knsv/mermaid/pull/595) ([frankschmitt](https://github.com/frankschmitt)) - Spec fix 1 [\#595](https://github.com/knsv/mermaid/pull/595) ([frankschmitt](https://github.com/frankschmitt))
## [7.0.5](https://github.com/knsv/mermaid/tree/7.0.5) (2017-09-01) ## [7.0.5](https://github.com/knsv/mermaid/tree/7.0.5) (2017-09-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/7.0.3...7.0.5) [Full Changelog](https://github.com/knsv/mermaid/compare/7.0.3...7.0.5)
**Closed issues:** **Closed issues:**
@ -376,6 +377,7 @@ By doing this clicks and tags are again allowed.
- New documentation - need improved logo [\#216](https://github.com/knsv/mermaid/issues/216) - New documentation - need improved logo [\#216](https://github.com/knsv/mermaid/issues/216)
## [7.0.3](https://github.com/knsv/mermaid/tree/7.0.3) (2017-06-04) ## [7.0.3](https://github.com/knsv/mermaid/tree/7.0.3) (2017-06-04)
[Full Changelog](https://github.com/knsv/mermaid/compare/7.0.2...7.0.3) [Full Changelog](https://github.com/knsv/mermaid/compare/7.0.2...7.0.3)
**Closed issues:** **Closed issues:**
@ -384,6 +386,7 @@ By doing this clicks and tags are again allowed.
- Good example of interactivity with mermaidAPI [\#514](https://github.com/knsv/mermaid/issues/514) - Good example of interactivity with mermaidAPI [\#514](https://github.com/knsv/mermaid/issues/514)
## [7.0.2](https://github.com/knsv/mermaid/tree/7.0.2) (2017-06-01) ## [7.0.2](https://github.com/knsv/mermaid/tree/7.0.2) (2017-06-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/7.0.0...7.0.2) [Full Changelog](https://github.com/knsv/mermaid/compare/7.0.0...7.0.2)
**Closed issues:** **Closed issues:**
@ -421,6 +424,7 @@ By doing this clicks and tags are again allowed.
- add par statement to sequenceDiagram [\#470](https://github.com/knsv/mermaid/pull/470) ([u-minor](https://github.com/u-minor)) - add par statement to sequenceDiagram [\#470](https://github.com/knsv/mermaid/pull/470) ([u-minor](https://github.com/u-minor))
## [7.0.0](https://github.com/knsv/mermaid/tree/7.0.0) (2017-01-29) ## [7.0.0](https://github.com/knsv/mermaid/tree/7.0.0) (2017-01-29)
[Full Changelog](https://github.com/knsv/mermaid/compare/6.0.0...7.0.0) [Full Changelog](https://github.com/knsv/mermaid/compare/6.0.0...7.0.0)
**Implemented enhancements:** **Implemented enhancements:**
@ -434,7 +438,7 @@ By doing this clicks and tags are again allowed.
- Can not be generated PNG pictures through CLI with Chinese [\#451](https://github.com/knsv/mermaid/issues/451) - Can not be generated PNG pictures through CLI with Chinese [\#451](https://github.com/knsv/mermaid/issues/451)
- Round nodes cannot be styled with CSS classes [\#443](https://github.com/knsv/mermaid/issues/443) - Round nodes cannot be styled with CSS classes [\#443](https://github.com/knsv/mermaid/issues/443)
- webpack gulp UglifyJsPlugin error. [\#440](https://github.com/knsv/mermaid/issues/440) - webpack gulp UglifyJsPlugin error. [\#440](https://github.com/knsv/mermaid/issues/440)
- String concatenation isn't working [\#432](https://github.com/knsv/mermaid/issues/432) - String concatenation isn't working [\#432](https://github.com/knsv/mermaid/issues/432)
- text flow/wrap in actor box of sequence diagram [\#422](https://github.com/knsv/mermaid/issues/422) - text flow/wrap in actor box of sequence diagram [\#422](https://github.com/knsv/mermaid/issues/422)
- Online live editor still use old version [\#402](https://github.com/knsv/mermaid/issues/402) - Online live editor still use old version [\#402](https://github.com/knsv/mermaid/issues/402)
- uncaught TypeError: t.getTransformToElement is not a function [\#401](https://github.com/knsv/mermaid/issues/401) - uncaught TypeError: t.getTransformToElement is not a function [\#401](https://github.com/knsv/mermaid/issues/401)
@ -459,7 +463,7 @@ By doing this clicks and tags are again allowed.
- fix gantt chart cli configuration parsing including functions [\#430](https://github.com/knsv/mermaid/pull/430) ([whyzdev](https://github.com/whyzdev)) - fix gantt chart cli configuration parsing including functions [\#430](https://github.com/knsv/mermaid/pull/430) ([whyzdev](https://github.com/whyzdev))
- Uses an empty text node instead of a string for svg group labels [\#429](https://github.com/knsv/mermaid/pull/429) ([daveaglick](https://github.com/daveaglick)) - Uses an empty text node instead of a string for svg group labels [\#429](https://github.com/knsv/mermaid/pull/429) ([daveaglick](https://github.com/daveaglick))
- use tspan via d3.textwrap to place actor text in sequence diagram [\#427](https://github.com/knsv/mermaid/pull/427) ([whyzdev](https://github.com/whyzdev)) - use tspan via d3.textwrap to place actor text in sequence diagram [\#427](https://github.com/knsv/mermaid/pull/427) ([whyzdev](https://github.com/whyzdev))
- \#422 use foreignObject/div to place actor label in sequence diagram [\#423](https://github.com/knsv/mermaid/pull/423) ([whyzdev](https://github.com/whyzdev)) - \#422 use foreignObject/div to place actor label in sequence diagram [\#423](https://github.com/knsv/mermaid/pull/423) ([whyzdev](https://github.com/whyzdev))
- Clarify the need for a CSS stylesheet [\#413](https://github.com/knsv/mermaid/pull/413) ([sifb](https://github.com/sifb)) - Clarify the need for a CSS stylesheet [\#413](https://github.com/knsv/mermaid/pull/413) ([sifb](https://github.com/sifb))
- Added hads downstream project [\#412](https://github.com/knsv/mermaid/pull/412) ([sinedied](https://github.com/sinedied)) - Added hads downstream project [\#412](https://github.com/knsv/mermaid/pull/412) ([sinedied](https://github.com/sinedied))
- update usage and fix \#273 [\#406](https://github.com/knsv/mermaid/pull/406) ([jinntrance](https://github.com/jinntrance)) - update usage and fix \#273 [\#406](https://github.com/knsv/mermaid/pull/406) ([jinntrance](https://github.com/jinntrance))
@ -474,6 +478,7 @@ By doing this clicks and tags are again allowed.
- Fix typo in the sequence diagram documentation [\#369](https://github.com/knsv/mermaid/pull/369) ([ggpasqualino](https://github.com/ggpasqualino)) - Fix typo in the sequence diagram documentation [\#369](https://github.com/knsv/mermaid/pull/369) ([ggpasqualino](https://github.com/ggpasqualino))
## [6.0.0](https://github.com/knsv/mermaid/tree/6.0.0) (2016-05-29) ## [6.0.0](https://github.com/knsv/mermaid/tree/6.0.0) (2016-05-29)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.8...6.0.0) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.8...6.0.0)
**Closed issues:** **Closed issues:**
@ -512,9 +517,11 @@ By doing this clicks and tags are again allowed.
- Quote phantomPath so that it doesn't fail on window [\#286](https://github.com/knsv/mermaid/pull/286) ([raghur](https://github.com/raghur)) - Quote phantomPath so that it doesn't fail on window [\#286](https://github.com/knsv/mermaid/pull/286) ([raghur](https://github.com/raghur))
## [0.5.8](https://github.com/knsv/mermaid/tree/0.5.8) (2016-01-27) ## [0.5.8](https://github.com/knsv/mermaid/tree/0.5.8) (2016-01-27)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.7...0.5.8) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.7...0.5.8)
## [0.5.7](https://github.com/knsv/mermaid/tree/0.5.7) (2016-01-25) ## [0.5.7](https://github.com/knsv/mermaid/tree/0.5.7) (2016-01-25)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.6...0.5.7) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.6...0.5.7)
**Closed issues:** **Closed issues:**
@ -536,6 +543,7 @@ By doing this clicks and tags are again allowed.
- Allow sequenceDiagram participant aliasing [\#265](https://github.com/knsv/mermaid/pull/265) ([gibson042](https://github.com/gibson042)) - Allow sequenceDiagram participant aliasing [\#265](https://github.com/knsv/mermaid/pull/265) ([gibson042](https://github.com/gibson042))
## [0.5.6](https://github.com/knsv/mermaid/tree/0.5.6) (2015-11-22) ## [0.5.6](https://github.com/knsv/mermaid/tree/0.5.6) (2015-11-22)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.5...0.5.6) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.5...0.5.6)
**Implemented enhancements:** **Implemented enhancements:**
@ -572,6 +580,7 @@ By doing this clicks and tags are again allowed.
- Add a Gitter chat badge to README.md [\#230](https://github.com/knsv/mermaid/pull/230) ([gitter-badger](https://github.com/gitter-badger)) - Add a Gitter chat badge to README.md [\#230](https://github.com/knsv/mermaid/pull/230) ([gitter-badger](https://github.com/gitter-badger))
## [0.5.5](https://github.com/knsv/mermaid/tree/0.5.5) (2015-10-21) ## [0.5.5](https://github.com/knsv/mermaid/tree/0.5.5) (2015-10-21)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.4...0.5.5) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.4...0.5.5)
**Closed issues:** **Closed issues:**
@ -583,6 +592,7 @@ By doing this clicks and tags are again allowed.
- Fix a typo: crosshead --\> arrowhead [\#228](https://github.com/knsv/mermaid/pull/228) ([tylerlong](https://github.com/tylerlong)) - Fix a typo: crosshead --\> arrowhead [\#228](https://github.com/knsv/mermaid/pull/228) ([tylerlong](https://github.com/tylerlong))
## [0.5.4](https://github.com/knsv/mermaid/tree/0.5.4) (2015-10-19) ## [0.5.4](https://github.com/knsv/mermaid/tree/0.5.4) (2015-10-19)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.3...0.5.4) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.3...0.5.4)
**Implemented enhancements:** **Implemented enhancements:**
@ -608,9 +618,11 @@ By doing this clicks and tags are again allowed.
- Remove duplicate npm dependencies: d3 and he [\#223](https://github.com/knsv/mermaid/pull/223) ([spect88](https://github.com/spect88)) - Remove duplicate npm dependencies: d3 and he [\#223](https://github.com/knsv/mermaid/pull/223) ([spect88](https://github.com/spect88))
## [0.5.3](https://github.com/knsv/mermaid/tree/0.5.3) (2015-10-04) ## [0.5.3](https://github.com/knsv/mermaid/tree/0.5.3) (2015-10-04)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.2...0.5.3) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.2...0.5.3)
## [0.5.2](https://github.com/knsv/mermaid/tree/0.5.2) (2015-10-04) ## [0.5.2](https://github.com/knsv/mermaid/tree/0.5.2) (2015-10-04)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.1...0.5.2) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.1...0.5.2)
**Implemented enhancements:** **Implemented enhancements:**
@ -623,7 +635,7 @@ By doing this clicks and tags are again allowed.
- node feature request [\#211](https://github.com/knsv/mermaid/issues/211) - node feature request [\#211](https://github.com/knsv/mermaid/issues/211)
- Please add prefix for styles [\#208](https://github.com/knsv/mermaid/issues/208) - Please add prefix for styles [\#208](https://github.com/knsv/mermaid/issues/208)
- Bad handling of block arguments [\#207](https://github.com/knsv/mermaid/issues/207) - Bad handling of block arguments [\#207](https://github.com/knsv/mermaid/issues/207)
- please consider port to mac osx [\#203](https://github.com/knsv/mermaid/issues/203) - please consider port to mac osx [\#203](https://github.com/knsv/mermaid/issues/203)
- allow phantomjs \>=1.9.x [\#201](https://github.com/knsv/mermaid/issues/201) - allow phantomjs \>=1.9.x [\#201](https://github.com/knsv/mermaid/issues/201)
- syntax for venn diagrams? [\#200](https://github.com/knsv/mermaid/issues/200) - syntax for venn diagrams? [\#200](https://github.com/knsv/mermaid/issues/200)
- Broken CLI Graphs? \(v0.5.1\) [\#196](https://github.com/knsv/mermaid/issues/196) - Broken CLI Graphs? \(v0.5.1\) [\#196](https://github.com/knsv/mermaid/issues/196)
@ -650,7 +662,7 @@ By doing this clicks and tags are again allowed.
- Last word in comment boxes getting cut off by word wrap library : \( [\#195](https://github.com/knsv/mermaid/issues/195) - Last word in comment boxes getting cut off by word wrap library : \( [\#195](https://github.com/knsv/mermaid/issues/195)
- Escaping characters in sequence diagram [\#193](https://github.com/knsv/mermaid/issues/193) - Escaping characters in sequence diagram [\#193](https://github.com/knsv/mermaid/issues/193)
- SVG foreignObject rendering [\#180](https://github.com/knsv/mermaid/issues/180) - SVG foreignObject rendering [\#180](https://github.com/knsv/mermaid/issues/180)
- IE9 issue [\#179](https://github.com/knsv/mermaid/issues/179) - IE9 issue [\#179](https://github.com/knsv/mermaid/issues/179)
- inoperable in an AMD/requirejs environment: IPython Notebook [\#127](https://github.com/knsv/mermaid/issues/127) - inoperable in an AMD/requirejs environment: IPython Notebook [\#127](https://github.com/knsv/mermaid/issues/127)
- \[Parser\] Hyphen in participant name bring TypeError [\#74](https://github.com/knsv/mermaid/issues/74) - \[Parser\] Hyphen in participant name bring TypeError [\#74](https://github.com/knsv/mermaid/issues/74)
@ -663,6 +675,7 @@ By doing this clicks and tags are again allowed.
- Update phantomscript.js [\#182](https://github.com/knsv/mermaid/pull/182) ([phairow](https://github.com/phairow)) - Update phantomscript.js [\#182](https://github.com/knsv/mermaid/pull/182) ([phairow](https://github.com/phairow))
## [0.5.1](https://github.com/knsv/mermaid/tree/0.5.1) (2015-06-21) ## [0.5.1](https://github.com/knsv/mermaid/tree/0.5.1) (2015-06-21)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.5.0...0.5.1) [Full Changelog](https://github.com/knsv/mermaid/compare/0.5.0...0.5.1)
**Implemented enhancements:** **Implemented enhancements:**
@ -699,6 +712,7 @@ By doing this clicks and tags are again allowed.
- Remove moot `version` property from bower.json [\#172](https://github.com/knsv/mermaid/pull/172) ([kkirsche](https://github.com/kkirsche)) - Remove moot `version` property from bower.json [\#172](https://github.com/knsv/mermaid/pull/172) ([kkirsche](https://github.com/kkirsche))
## [0.5.0](https://github.com/knsv/mermaid/tree/0.5.0) (2015-06-07) ## [0.5.0](https://github.com/knsv/mermaid/tree/0.5.0) (2015-06-07)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.4.0...0.5.0) [Full Changelog](https://github.com/knsv/mermaid/compare/0.4.0...0.5.0)
**Implemented enhancements:** **Implemented enhancements:**
@ -734,6 +748,7 @@ By doing this clicks and tags are again allowed.
- Use a library-level variable for assigning ids [\#134](https://github.com/knsv/mermaid/pull/134) ([bollwyvl](https://github.com/bollwyvl)) - Use a library-level variable for assigning ids [\#134](https://github.com/knsv/mermaid/pull/134) ([bollwyvl](https://github.com/bollwyvl))
## [0.4.0](https://github.com/knsv/mermaid/tree/0.4.0) (2015-03-01) ## [0.4.0](https://github.com/knsv/mermaid/tree/0.4.0) (2015-03-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.3.5...0.4.0) [Full Changelog](https://github.com/knsv/mermaid/compare/0.3.5...0.4.0)
**Implemented enhancements:** **Implemented enhancements:**
@ -752,9 +767,11 @@ By doing this clicks and tags are again allowed.
- Internet Explorer Support [\#99](https://github.com/knsv/mermaid/issues/99) - Internet Explorer Support [\#99](https://github.com/knsv/mermaid/issues/99)
## [0.3.5](https://github.com/knsv/mermaid/tree/0.3.5) (2015-02-15) ## [0.3.5](https://github.com/knsv/mermaid/tree/0.3.5) (2015-02-15)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.3.4...0.3.5) [Full Changelog](https://github.com/knsv/mermaid/compare/0.3.4...0.3.5)
## [0.3.4](https://github.com/knsv/mermaid/tree/0.3.4) (2015-02-15) ## [0.3.4](https://github.com/knsv/mermaid/tree/0.3.4) (2015-02-15)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.3.3...0.3.4) [Full Changelog](https://github.com/knsv/mermaid/compare/0.3.3...0.3.4)
**Implemented enhancements:** **Implemented enhancements:**
@ -785,6 +802,7 @@ By doing this clicks and tags are again allowed.
- Ignore all files except the license and dist/ folder when installing with Bower. [\#112](https://github.com/knsv/mermaid/pull/112) ([jasonbellamy](https://github.com/jasonbellamy)) - Ignore all files except the license and dist/ folder when installing with Bower. [\#112](https://github.com/knsv/mermaid/pull/112) ([jasonbellamy](https://github.com/jasonbellamy))
## [0.3.3](https://github.com/knsv/mermaid/tree/0.3.3) (2015-01-25) ## [0.3.3](https://github.com/knsv/mermaid/tree/0.3.3) (2015-01-25)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.3.2...0.3.3) [Full Changelog](https://github.com/knsv/mermaid/compare/0.3.2...0.3.3)
**Implemented enhancements:** **Implemented enhancements:**
@ -805,6 +823,7 @@ By doing this clicks and tags are again allowed.
- fix html tags in example usage [\#100](https://github.com/knsv/mermaid/pull/100) ([deiwin](https://github.com/deiwin)) - fix html tags in example usage [\#100](https://github.com/knsv/mermaid/pull/100) ([deiwin](https://github.com/deiwin))
## [0.3.2](https://github.com/knsv/mermaid/tree/0.3.2) (2015-01-11) ## [0.3.2](https://github.com/knsv/mermaid/tree/0.3.2) (2015-01-11)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.3.1...0.3.2) [Full Changelog](https://github.com/knsv/mermaid/compare/0.3.1...0.3.2)
**Implemented enhancements:** **Implemented enhancements:**
@ -827,6 +846,7 @@ By doing this clicks and tags are again allowed.
- Template change [\#88](https://github.com/knsv/mermaid/pull/88) ([gkchic](https://github.com/gkchic)) - Template change [\#88](https://github.com/knsv/mermaid/pull/88) ([gkchic](https://github.com/gkchic))
## [0.3.1](https://github.com/knsv/mermaid/tree/0.3.1) (2015-01-05) ## [0.3.1](https://github.com/knsv/mermaid/tree/0.3.1) (2015-01-05)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.3.0...0.3.1) [Full Changelog](https://github.com/knsv/mermaid/compare/0.3.0...0.3.1)
**Implemented enhancements:** **Implemented enhancements:**
@ -849,6 +869,7 @@ By doing this clicks and tags are again allowed.
- Add apostrophe & 'and' [\#72](https://github.com/knsv/mermaid/pull/72) ([sudodoki](https://github.com/sudodoki)) - Add apostrophe & 'and' [\#72](https://github.com/knsv/mermaid/pull/72) ([sudodoki](https://github.com/sudodoki))
## [0.3.0](https://github.com/knsv/mermaid/tree/0.3.0) (2014-12-22) ## [0.3.0](https://github.com/knsv/mermaid/tree/0.3.0) (2014-12-22)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.16...0.3.0) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.16...0.3.0)
**Implemented enhancements:** **Implemented enhancements:**
@ -871,6 +892,7 @@ By doing this clicks and tags are again allowed.
- Allow special symbols for direction along with acronyms [\#66](https://github.com/knsv/mermaid/pull/66) ([vijay40](https://github.com/vijay40)) - Allow special symbols for direction along with acronyms [\#66](https://github.com/knsv/mermaid/pull/66) ([vijay40](https://github.com/vijay40))
## [0.2.16](https://github.com/knsv/mermaid/tree/0.2.16) (2014-12-15) ## [0.2.16](https://github.com/knsv/mermaid/tree/0.2.16) (2014-12-15)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.15...0.2.16) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.15...0.2.16)
**Fixed bugs:** **Fixed bugs:**
@ -891,11 +913,12 @@ By doing this clicks and tags are again allowed.
- New grammar will allow statements ending without semicolon as disccused in Issue \#38 [\#63](https://github.com/knsv/mermaid/pull/63) ([vijay40](https://github.com/vijay40)) - New grammar will allow statements ending without semicolon as disccused in Issue \#38 [\#63](https://github.com/knsv/mermaid/pull/63) ([vijay40](https://github.com/vijay40))
- Class based styling [\#62](https://github.com/knsv/mermaid/pull/62) ([bjowes](https://github.com/bjowes)) - Class based styling [\#62](https://github.com/knsv/mermaid/pull/62) ([bjowes](https://github.com/bjowes))
- Fix typos [\#60](https://github.com/knsv/mermaid/pull/60) ([sublimino](https://github.com/sublimino)) - Fix typos [\#60](https://github.com/knsv/mermaid/pull/60) ([sublimino](https://github.com/sublimino))
- Included .DS\_Store in gitignore [\#57](https://github.com/knsv/mermaid/pull/57) ([alvynmcq](https://github.com/alvynmcq)) - Included .DS_Store in gitignore [\#57](https://github.com/knsv/mermaid/pull/57) ([alvynmcq](https://github.com/alvynmcq))
- Improves readability discussed in issue \#38 [\#56](https://github.com/knsv/mermaid/pull/56) ([vijay40](https://github.com/vijay40)) - Improves readability discussed in issue \#38 [\#56](https://github.com/knsv/mermaid/pull/56) ([vijay40](https://github.com/vijay40))
- Added a linting task for gulp [\#43](https://github.com/knsv/mermaid/pull/43) ([serv](https://github.com/serv)) - Added a linting task for gulp [\#43](https://github.com/knsv/mermaid/pull/43) ([serv](https://github.com/serv))
## [0.2.15](https://github.com/knsv/mermaid/tree/0.2.15) (2014-12-05) ## [0.2.15](https://github.com/knsv/mermaid/tree/0.2.15) (2014-12-05)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.14...0.2.15) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.14...0.2.15)
**Fixed bugs:** **Fixed bugs:**
@ -911,13 +934,15 @@ By doing this clicks and tags are again allowed.
**Merged pull requests:** **Merged pull requests:**
- Include bower\_components/ to .gitignore [\#33](https://github.com/knsv/mermaid/pull/33) ([serv](https://github.com/serv)) - Include bower_components/ to .gitignore [\#33](https://github.com/knsv/mermaid/pull/33) ([serv](https://github.com/serv))
- Fixed reference to Git repo. [\#32](https://github.com/knsv/mermaid/pull/32) ([guyellis](https://github.com/guyellis)) - Fixed reference to Git repo. [\#32](https://github.com/knsv/mermaid/pull/32) ([guyellis](https://github.com/guyellis))
## [0.2.14](https://github.com/knsv/mermaid/tree/0.2.14) (2014-12-03) ## [0.2.14](https://github.com/knsv/mermaid/tree/0.2.14) (2014-12-03)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.13...0.2.14) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.13...0.2.14)
## [0.2.13](https://github.com/knsv/mermaid/tree/0.2.13) (2014-12-03) ## [0.2.13](https://github.com/knsv/mermaid/tree/0.2.13) (2014-12-03)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.10...0.2.13) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.10...0.2.13)
**Implemented enhancements:** **Implemented enhancements:**
@ -932,9 +957,11 @@ By doing this clicks and tags are again allowed.
- Support unicode chars in labels [\#9](https://github.com/knsv/mermaid/issues/9) - Support unicode chars in labels [\#9](https://github.com/knsv/mermaid/issues/9)
## [0.2.10](https://github.com/knsv/mermaid/tree/0.2.10) (2014-12-01) ## [0.2.10](https://github.com/knsv/mermaid/tree/0.2.10) (2014-12-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.9...0.2.10) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.9...0.2.10)
## [0.2.9](https://github.com/knsv/mermaid/tree/0.2.9) (2014-12-01) ## [0.2.9](https://github.com/knsv/mermaid/tree/0.2.9) (2014-12-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.8...0.2.9) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.8...0.2.9)
**Closed issues:** **Closed issues:**
@ -947,9 +974,11 @@ By doing this clicks and tags are again allowed.
- Allow unicode chars in labels [\#13](https://github.com/knsv/mermaid/pull/13) ([codebeige](https://github.com/codebeige)) - Allow unicode chars in labels [\#13](https://github.com/knsv/mermaid/pull/13) ([codebeige](https://github.com/codebeige))
## [0.2.8](https://github.com/knsv/mermaid/tree/0.2.8) (2014-12-01) ## [0.2.8](https://github.com/knsv/mermaid/tree/0.2.8) (2014-12-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.7...0.2.8) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.7...0.2.8)
## [0.2.7](https://github.com/knsv/mermaid/tree/0.2.7) (2014-12-01) ## [0.2.7](https://github.com/knsv/mermaid/tree/0.2.7) (2014-12-01)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.6...0.2.7) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.6...0.2.7)
**Closed issues:** **Closed issues:**
@ -957,9 +986,11 @@ By doing this clicks and tags are again allowed.
- Provide parser as separate module [\#4](https://github.com/knsv/mermaid/issues/4) - Provide parser as separate module [\#4](https://github.com/knsv/mermaid/issues/4)
## [0.2.6](https://github.com/knsv/mermaid/tree/0.2.6) (2014-11-27) ## [0.2.6](https://github.com/knsv/mermaid/tree/0.2.6) (2014-11-27)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.5...0.2.6) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.5...0.2.6)
## [0.2.5](https://github.com/knsv/mermaid/tree/0.2.5) (2014-11-27) ## [0.2.5](https://github.com/knsv/mermaid/tree/0.2.5) (2014-11-27)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.4...0.2.5) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.4...0.2.5)
**Merged pull requests:** **Merged pull requests:**
@ -967,21 +998,27 @@ By doing this clicks and tags are again allowed.
- Added new shapes! [\#1](https://github.com/knsv/mermaid/pull/1) ([bjowes](https://github.com/bjowes)) - Added new shapes! [\#1](https://github.com/knsv/mermaid/pull/1) ([bjowes](https://github.com/bjowes))
## [0.2.4](https://github.com/knsv/mermaid/tree/0.2.4) (2014-11-25) ## [0.2.4](https://github.com/knsv/mermaid/tree/0.2.4) (2014-11-25)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.3...0.2.4) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.3...0.2.4)
## [0.2.3](https://github.com/knsv/mermaid/tree/0.2.3) (2014-11-24) ## [0.2.3](https://github.com/knsv/mermaid/tree/0.2.3) (2014-11-24)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.2...0.2.3) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.2...0.2.3)
## [0.2.2](https://github.com/knsv/mermaid/tree/0.2.2) (2014-11-22) ## [0.2.2](https://github.com/knsv/mermaid/tree/0.2.2) (2014-11-22)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.1...0.2.2) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.1...0.2.2)
## [0.2.1](https://github.com/knsv/mermaid/tree/0.2.1) (2014-11-22) ## [0.2.1](https://github.com/knsv/mermaid/tree/0.2.1) (2014-11-22)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.2.0...0.2.1) [Full Changelog](https://github.com/knsv/mermaid/compare/0.2.0...0.2.1)
## [0.2.0](https://github.com/knsv/mermaid/tree/0.2.0) (2014-11-22) ## [0.2.0](https://github.com/knsv/mermaid/tree/0.2.0) (2014-11-22)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.1.1...0.2.0) [Full Changelog](https://github.com/knsv/mermaid/compare/0.1.1...0.2.0)
## [0.1.1](https://github.com/knsv/mermaid/tree/0.1.1) (2014-11-17) ## [0.1.1](https://github.com/knsv/mermaid/tree/0.1.1) (2014-11-17)
[Full Changelog](https://github.com/knsv/mermaid/compare/0.1.0...0.1.1) [Full Changelog](https://github.com/knsv/mermaid/compare/0.1.0...0.1.1)
## [0.1.0](https://github.com/knsv/mermaid/tree/0.1.0) (2014-11-16) ## [0.1.0](https://github.com/knsv/mermaid/tree/0.1.0) (2014-11-16)

19
src/docs/Configuration.md
View File

@ -1,27 +1,20 @@
# Configuration # Configuration
Configuration is the second half of Mermaid, after deployment. Together Deployment and Configuration constitute the whole of Mermaid. Configuration is the second half of Mermaid, after deployment. Together Deployment and Configuration constitute the whole of Mermaid.
This section will introduce the different methods of configuring of the behaviors and appearances of Mermaid Diagrams. This section will introduce the different methods of configuring of the behaviors and appearances of Mermaid Diagrams.
The Following are the most commonly used methods, and are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods. The Following are the most commonly used methods, and are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods.
## Configuration Section in the [Live Editor](https://mermaid.live/). ## Configuration Section in the [Live Editor](https://mermaid.live/).
## The `initialize()` call, for when Mermaid is called via an API, or through a <script> tag.
## The `initialize()` call, for when Mermaid is called via an API, or through a <script> tag.
## [Directives](./directives.md), ## [Directives](./directives.md),
allows the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. you can pass a directive alongside your definition inside `%%{ }%%`, either above or below your diagram definition. allows the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. you can pass a directive alongside your definition inside `%%{ }%%`, either above or below your diagram definition.
## Theme Creation: ## Theme Creation:
An application of using Directives to change [Themes](./theming.md). `Theme` is an value within mermaid's configuration that dictates the color scheme for diagrams.
An application of using Directives to change [Themes](./theming.md). `Theme` is an value within mermaid's configuration that dictates the color scheme for diagrams.
If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](./Setup.md) here. It includes themes If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](./Setup.md) here. It includes themes

20
src/docs/README.md
View File

@ -192,7 +192,7 @@ To Deploy Mermaid:
```html ```html
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
``` ```
@ -202,10 +202,10 @@ To Deploy Mermaid:
## Sibling projects ## Sibling projects
- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) - [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) - [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli)
- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) - [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo)
- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) - [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo)
## Request for Assistance ## Request for Assistance
@ -217,8 +217,8 @@ represent the project when answering questions and issues.
Together we could continue the work with things like: Together we could continue the work with things like:
- Adding more types of diagrams like mindmaps, ert diagrams, etc. - Adding more types of diagrams like mindmaps, ert diagrams, etc.
- Improving existing diagrams - Improving existing diagrams
Don't hesitate to contact me if you want to get involved! Don't hesitate to contact me if you want to get involved!
@ -267,9 +267,9 @@ The above command generates files into the `dist` folder and publishes them to n
## Related projects ## Related projects
- [Command Line Interface](https://github.com/mermaid-js/mermaid-cli) - [Command Line Interface](https://github.com/mermaid-js/mermaid-cli)
- [Live Editor](https://github.com/mermaid-js/mermaid-live-editor) - [Live Editor](https://github.com/mermaid-js/mermaid-live-editor)
- [HTTP Server](https://github.com/TomWright/mermaid-server) - [HTTP Server](https://github.com/TomWright/mermaid-server)
## Contributors [![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) ## Contributors [![Good first issue](https://img.shields.io/github/labels/mermaid-js/mermaid/Good%20first%20issue%21)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22) [![Contributors](https://img.shields.io/github/contributors/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors) [![Commits](https://img.shields.io/github/commit-activity/m/mermaid-js/mermaid)](https://github.com/mermaid-js/mermaid/graphs/contributors)

62
src/docs/Setup.md
View File

@ -64,12 +64,12 @@ Theme , the CSS style sheet
**Notes:** **Notes:**
- Trace: 0 - Trace: 0
- Debug: 1 - Debug: 1
- Info: 2 - Info: 2
- Warn: 3 - Warn: 3
- Error: 4 - Error: 4
- Fatal: 5 (default) - Fatal: 5 (default)
## securityLevel ## securityLevel
@ -79,13 +79,13 @@ Theme , the CSS style sheet
**Notes**: **Notes**:
- **strict**: (**default**) tags in text are encoded, click functionality is disabled - **strict**: (**default**) tags in text are encoded, click functionality is disabled
- **loose**: tags in text are allowed, click functionality is enabled - **loose**: tags in text are allowed, click functionality is enabled
- **antiscript**: html tags in text are allowed, (only script element is removed), click - **antiscript**: html tags in text are allowed, (only script element is removed), click
functionality is enabled functionality is enabled
- **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This - **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This
prevent any JavaScript from running in the context. This may hinder interactive functionality prevent any JavaScript from running in the context. This may hinder interactive functionality
of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc.
## startOnLoad ## startOnLoad
@ -1420,7 +1420,7 @@ function _Default value: At default, will mirror Global Config_
### Parameters ### Parameters
- `conf` **MermaidConfig** The base currentConfig to use as siteConfig - `conf` **MermaidConfig** The base currentConfig to use as siteConfig
Returns **[object][5]** The siteConfig Returns **[object][5]** The siteConfig
@ -1450,7 +1450,7 @@ corresponding siteConfig value.
### Parameters ### Parameters
- `conf` **any** The potential currentConfig - `conf` **any** The potential currentConfig
Returns **any** The currentConfig merged with the sanitized conf Returns **any** The currentConfig merged with the sanitized conf
@ -1473,14 +1473,14 @@ $(function () {
### Parameters ### Parameters
- `id` **[string][6]** The id of the element to be rendered - `id` **[string][6]** The id of the element to be rendered
- `text` **[string][6]** The graph definition - `text` **[string][6]** The graph definition
- `cb` **function (svgCode: [string][6], bindFunctions: function (element: [Element][7]): void): void** - `cb` **function (svgCode: [string][6], bindFunctions: function (element: [Element][7]): void): void**
- `container` **[Element][7]** Selector to element in which a div with the graph temporarily will be - `container` **[Element][7]** Selector to element in which a div with the graph temporarily will be
inserted. If one is provided a hidden div will be inserted in the body of the page instead. The inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
element will be removed when rendering is completed. element will be removed when rendering is completed.
Returns **void** Returns **void**
## getConfig ## getConfig
@ -1507,7 +1507,7 @@ options in-place
### Parameters ### Parameters
- `options` **any** The potential setConfig parameter - `options` **any** The potential setConfig parameter
## addDirective ## addDirective
@ -1515,7 +1515,7 @@ Pushes in a directive to the configuration
### Parameters ### Parameters
- `directive` **[object][5]** The directive to push in - `directive` **[object][5]** The directive to push in
## reset ## reset
@ -1535,17 +1535,17 @@ Pushes in a directive to the configuration
### Parameters ### Parameters
- `config` (optional, default `siteConfig`) - `config` (optional, default `siteConfig`)
Returns **void** Returns **void**
## initialize ## initialize
### Parameters ### Parameters
- `options` **MermaidConfig** - `options` **MermaidConfig**
## ##
## mermaidAPI configuration defaults ## mermaidAPI configuration defaults
@ -1610,15 +1610,9 @@ Returns **void**
``` ```
[1]: https://github.com/mermaid-js/mermaid/blob/develop/src/mermaidAPI.js [1]: https://github.com/mermaid-js/mermaid/blob/develop/src/mermaidAPI.js
[2]: Setup.md?id=render [2]: Setup.md?id=render
[3]: 8.6.0_docs.md [3]: 8.6.0_docs.md
[4]: #mermaidapi-configuration-defaults [4]: #mermaidapi-configuration-defaults
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
[7]: https://developer.mozilla.org/docs/Web/API/Element [7]: https://developer.mozilla.org/docs/Web/API/Element

8
src/docs/Tutorials.md
View File

@ -1,13 +1,13 @@
# Tutorials # Tutorials
This is list of publicly available Tutorials for using Mermaid.JS . This is intended as a basic introduction for the use of the Live Editor for generating diagrams, and deploying Mermaid.JS through HTML. This is list of publicly available Tutorials for using Mermaid.JS . This is intended as a basic introduction for the use of the Live Editor for generating diagrams, and deploying Mermaid.JS through HTML.
**Note that these tutorials might display an older interface, but the usage of the live-editor will largely be the same.** **Note that these tutorials might display an older interface, but the usage of the live-editor will largely be the same.**
For most purposes, you can use the [Live Editor](https://mermaid-js.github.io/mermaid-live-editor), to quickly and easily render a diagram. For most purposes, you can use the [Live Editor](https://mermaid-js.github.io/mermaid-live-editor), to quickly and easily render a diagram.
## Live-Editor Tutorials ## Live-Editor Tutorials
The definitions that can be generated the Live-Editor are also backwards-compatible as of version 8.7.0. The definitions that can be generated the Live-Editor are also backwards-compatible as of version 8.7.0.
[Chris Chinchilla: Hands on - Text-based diagrams with Mermaid](https://www.youtube.com/watch?v=4_LdV1cs2sA) [Chris Chinchilla: Hands on - Text-based diagrams with Mermaid](https://www.youtube.com/watch?v=4_LdV1cs2sA)
@ -20,8 +20,8 @@ The definitions that can be generated the Live-Editor are also backwards-compati
[Eddie Jaoude: Can you code your diagrams?](https://www.youtube.com/watch?v=9HZzKkAqrX8) [Eddie Jaoude: Can you code your diagrams?](https://www.youtube.com/watch?v=9HZzKkAqrX8)
## Mermaid with HTML ## Mermaid with HTML
Examples are provided in [Getting Started](n00b-gettingStarted.md) Examples are provided in [Getting Started](n00b-gettingStarted.md)
**CodePen Examples:** **CodePen Examples:**
@ -32,7 +32,6 @@ https://codepen.io/tdkn/pen/vZxQzd
https://codepen.io/janzeteachesit/pen/OWWZKN https://codepen.io/janzeteachesit/pen/OWWZKN
## Mermaid with Text Area ## Mermaid with Text Area
https://codepen.io/Ryuno-Ki/pen/LNxwgR https://codepen.io/Ryuno-Ki/pen/LNxwgR
@ -43,7 +42,6 @@ https://codepen.io/Ryuno-Ki/pen/LNxwgR
[K8s.dev blog: Improve your documentation with Mermaid.js diagrams](https://www.kubernetes.dev/blog/2021/12/01/improve-your-documentation-with-mermaid.js-diagrams/) [K8s.dev blog: Improve your documentation with Mermaid.js diagrams](https://www.kubernetes.dev/blog/2021/12/01/improve-your-documentation-with-mermaid.js-diagrams/)
## Jupyter Integration with mermaid-js ## Jupyter Integration with mermaid-js
Here's an example of Python integration with mermaid-js which uses the mermaid.ink service, that displays the graph in a Jupyter notebook. Here's an example of Python integration with mermaid-js which uses the mermaid.ink service, that displays the graph in a Jupyter notebook.

22
src/docs/_navbar.md
View File

@ -1,13 +1,13 @@
* Getting started - Getting started
* [Quick start](quickstart.md) - [Quick start](quickstart.md)
* [Writing more pages](more-pages.md) - [Writing more pages](more-pages.md)
* [Custom navbar](custom-navbar.md) - [Custom navbar](custom-navbar.md)
* [Cover page](cover.md) - [Cover page](cover.md)
* Configuration - Configuration
* [Configuration](configuration.md) - [Configuration](configuration.md)
* [Themes](themes.md) - [Themes](themes.md)
* [Using plugins](plugins.md) - [Using plugins](plugins.md)
* [Markdown configuration](markdown.md) - [Markdown configuration](markdown.md)
* [Language highlight](language-highlight.md) - [Language highlight](language-highlight.md)

2
src/docs/_sidebar.md
View File

@ -5,6 +5,7 @@
- [Syntax and Configuration](n00b-syntaxReference.md) - [Syntax and Configuration](n00b-syntaxReference.md)
- 📊 Diagram Syntax - 📊 Diagram Syntax
- [Flowchart](flowchart.md) - [Flowchart](flowchart.md)
- [Sequence Diagram](sequenceDiagram.md) - [Sequence Diagram](sequenceDiagram.md)
- [Class Diagram](classDiagram.md) - [Class Diagram](classDiagram.md)
@ -30,6 +31,7 @@
- [Advanced usage](n00b-advanced.md) - [Advanced usage](n00b-advanced.md)
- 📚 Misc - 📚 Misc
- [Use-Cases and Integrations](integrations.md) - [Use-Cases and Integrations](integrations.md)
- [FAQ](faq.md) - [FAQ](faq.md)

4
src/docs/accessibility.md
View File

@ -14,8 +14,8 @@ This support for accessibility options is available for all the diagrams/chart t
The diagram authors can now add the accessibility options in the diagram definition, using the `accTitle` and `accDescr` keywords, where each keyword is followed by `:` and the string value for title and description like: The diagram authors can now add the accessibility options in the diagram definition, using the `accTitle` and `accDescr` keywords, where each keyword is followed by `:` and the string value for title and description like:
- `accTitle: "Your Accessibility Title"` or - `accTitle: "Your Accessibility Title"` or
- `accDescr: "Your Accessibility Description"` - `accDescr: "Your Accessibility Description"`
**When these two options are defined, they will add a coressponding `<title>` and `<desc>` tag in the SVG.** **When these two options are defined, they will add a coressponding `<title>` and `<desc>` tag in the SVG.**

8
src/docs/breakingChanges.md
View File

@ -27,13 +27,13 @@ mermaid.initialize({
In old versions you needed to reference a CSS file in your HTML: In old versions you needed to reference a CSS file in your HTML:
```html ```html
<link rel="stylesheet" href="mermaid.min.css"> <link rel="stylesheet" href="mermaid.min.css" />
``` ```
or or
```html ```html
<link rel="stylesheet" href="mermaid.forest.min.css"> <link rel="stylesheet" href="mermaid.forest.min.css" />
``` ```
Now it is not needed, and there are no more CSS files in the distribution files. Now it is not needed, and there are no more CSS files in the distribution files.
@ -42,8 +42,8 @@ You just:
```javascript ```javascript
mermaid.initialize({ mermaid.initialize({
theme: 'forest' theme: 'forest',
}) });
``` ```
and it works like a charm because now the CSS is inline with the SVG to allow simpler portability. and it works like a charm because now the CSS is inline with the SVG to allow simpler portability.

136
src/docs/c4c.md
View File

@ -55,11 +55,11 @@ For an example, see the source code demos/index.html
5 types of C4 charts are supported. 5 types of C4 charts are supported.
- System Context (C4Context) - System Context (C4Context)
- Container diagram (C4Container) - Container diagram (C4Container)
- Component diagram (C4Component) - Component diagram (C4Component)
- Dynamic diagram (C4Dynamic) - Dynamic diagram (C4Dynamic)
- Deployment diagram (C4Deployment) - Deployment diagram (C4Deployment)
Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram. Please refer to the linked document [C4-PlantUML syntax](https://github.com/plantuml-stdlib/C4-PlantUML/blob/master/README.md) for how to write the c4 diagram.
@ -69,79 +69,79 @@ updateElementStyle and UpdateElementStyle are written in the diagram last part.
The layout does not use a fully automated layout algorithm. The position of shapes is adjusted by changing the order in which statements are written. So there is no plan to support the following Layout statements. The layout does not use a fully automated layout algorithm. The position of shapes is adjusted by changing the order in which statements are written. So there is no plan to support the following Layout statements.
The number of shapes per row and the number of boundaries can be adjusted using UpdateLayoutConfig. The number of shapes per row and the number of boundaries can be adjusted using UpdateLayoutConfig.
- Layout - Layout
- - Lay_U, Lay_Up - - Lay_U, Lay_Up
- - Lay_D, Lay_Down - - Lay_D, Lay_Down
- - Lay_L, Lay_Left - - Lay_L, Lay_Left
- - Lay_R, Lay_Right - - Lay_R, Lay_Right
The following unfinished features are not supported in the short term. The following unfinished features are not supported in the short term.
- [ ] sprite - [ ] sprite
- [ ] tags - [ ] tags
- [ ] link - [ ] link
- [ ] Legend - [ ] Legend
- [x] System Context - [x] System Context
- - [x] Person(alias, label, ?descr, ?sprite, ?tags, $link) - - [x] Person(alias, label, ?descr, ?sprite, ?tags, $link)
- - [x] Person_Ext - - [x] Person_Ext
- - [x] System(alias, label, ?descr, ?sprite, ?tags, $link) - - [x] System(alias, label, ?descr, ?sprite, ?tags, $link)
- - [x] SystemDb - - [x] SystemDb
- - [x] SystemQueue - - [x] SystemQueue
- - [x] System_Ext - - [x] System_Ext
- - [x] SystemDb_Ext - - [x] SystemDb_Ext
- - [x] SystemQueue_Ext - - [x] SystemQueue_Ext
- - [x] Boundary(alias, label, ?type, ?tags, $link) - - [x] Boundary(alias, label, ?type, ?tags, $link)
- - [x] Enterprise_Boundary(alias, label, ?tags, $link) - - [x] Enterprise_Boundary(alias, label, ?tags, $link)
- - [x] System_Boundary - - [x] System_Boundary
- [x] Container diagram - [x] Container diagram
- - [x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - - [x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link)
- - [x] ContainerDb - - [x] ContainerDb
- - [x] ContainerQueue - - [x] ContainerQueue
- - [x] Container_Ext - - [x] Container_Ext
- - [x] ContainerDb_Ext - - [x] ContainerDb_Ext
- - [x] ContainerQueue_Ext - - [x] ContainerQueue_Ext
- - [x] Container_Boundary(alias, label, ?tags, $link) - - [x] Container_Boundary(alias, label, ?tags, $link)
- [x] Component diagram - [x] Component diagram
- - [x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link) - - [x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link)
- - [x] ComponentDb - - [x] ComponentDb
- - [x] ComponentQueue - - [x] ComponentQueue
- - [x] Component_Ext - - [x] Component_Ext
- - [x] ComponentDb_Ext - - [x] ComponentDb_Ext
- - [x] ComponentQueue_Ext - - [x] ComponentQueue_Ext
- [x] Dynamic diagram - [x] Dynamic diagram
- - [x] RelIndex(index, from, to, label, ?tags, $link) - - [x] RelIndex(index, from, to, label, ?tags, $link)
- [x] Deployment diagram - [x] Deployment diagram
- - [x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link) - - [x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link)
- - [x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node() - - [x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node()
- - [x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node() - - [x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node()
- - [x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node() - - [x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node()
- [x] Relationship Types - [x] Relationship Types
- - [x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link) - - [x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link)
- - [x] BiRel (bidirectional relationship) - - [x] BiRel (bidirectional relationship)
- - [x] Rel_U, Rel_Up - - [x] Rel_U, Rel_Up
- - [x] Rel_D, Rel_Down - - [x] Rel_D, Rel_Down
- - [x] Rel_L, Rel_Left - - [x] Rel_L, Rel_Left
- - [x] Rel_R, Rel_Right - - [x] Rel_R, Rel_Right
- - [x] Rel_Back - - [x] Rel_Back
- - [x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written. - - [x] RelIndex \* Compatible with C4-Plantuml syntax, but ignores the index parameter. The sequence number is determined by the order in which the rel statements are written.
- [ ] Custom tags/stereotypes support and skinparam updates - [ ] Custom tags/stereotypes support and skinparam updates
- - [ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend. - - [ ] AddElementTag(tagStereo, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new element tag. The styles of the tagged elements are updated and the tag is displayed in the calculated legend.
- - [ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend. - - [ ] AddRelTag(tagStereo, ?textColor, ?lineColor, ?lineStyle, ?sprite, ?techn, ?legendText, ?legendSprite): Introduces a new Relationship tag. The styles of the tagged relationships are updated and the tag is displayed in the calculated legend.
- - [x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry. - - [x] UpdateElementStyle(elementName, ?bgColor, ?fontColor, ?borderColor, ?shadowing, ?shape, ?sprite, ?techn, ?legendText, ?legendSprite): This call updates the default style of the elements (component, ...) and creates no additional legend entry.
- - [x] UpdateRelStyle(from, to, ?textColor, ?lineColor, ?offsetX, ?offsetY): This call updates the default relationship colors and creates no additional legend entry. Two new parameters, offsetX and offsetY, are added to set the offset of the original position of the text. - - [x] UpdateRelStyle(from, to, ?textColor, ?lineColor, ?offsetX, ?offsetY): This call updates the default relationship colors and creates no additional legend entry. Two new parameters, offsetX and offsetY, are added to set the offset of the original position of the text.
- - [ ] RoundedBoxShape(): This call returns the name of the rounded box shape and can be used as ?shape argument. - - [ ] RoundedBoxShape(): This call returns the name of the rounded box shape and can be used as ?shape argument.
- - [ ] EightSidedShape(): This call returns the name of the eight sided shape and can be used as ?shape argument. - - [ ] EightSidedShape(): This call returns the name of the eight sided shape and can be used as ?shape argument.
- - [ ] DashedLine(): This call returns the name of the dashed line and can be used as ?lineStyle argument. - - [ ] DashedLine(): This call returns the name of the dashed line and can be used as ?lineStyle argument.
- - [ ] DottedLine(): This call returns the name of the dotted line and can be used as ?lineStyle argument. - - [ ] DottedLine(): This call returns the name of the dotted line and can be used as ?lineStyle argument.
- - [ ] BoldLine(): This call returns the name of the bold line and can be used as ?lineStyle argument. - - [ ] BoldLine(): This call returns the name of the bold line and can be used as ?lineStyle argument.
- - [x] UpdateLayoutConfig(?c4ShapeInRow, ?c4BoundaryInRow): New. This call updates the default c4ShapeInRow(4) and c4BoundaryInRow(2). - - [x] UpdateLayoutConfig(?c4ShapeInRow, ?c4BoundaryInRow): New. This call updates the default c4ShapeInRow(4) and c4BoundaryInRow(2).
There are two ways to assign parameters with question marks. One uses the non-named parameter assignment method in the order of the parameters, and the other uses the named parameter assignment method, where the name must start with a $ symbol. There are two ways to assign parameters with question marks. One uses the non-named parameter assignment method in the order of the parameters, and the other uses the named parameter assignment method, where the name must start with a $ symbol.

135
src/docs/classDiagram.md
View File

@ -100,7 +100,7 @@ class BankAccount{
#### Return Type #### Return Type
Optionally you can end a method/function definition with the data type that will be returned (note: there must be a space between the final `)` and the return type). An example: Optionally you can end a method/function definition with the data type that will be returned (note: there must be a space between the final `)` and the return type). An example:
```mermaid-example ```mermaid-example
classDiagram classDiagram
@ -146,13 +146,14 @@ To describe the visibility (or encapsulation) of an attribute or method/function
- `~` Package/Internal - `~` Package/Internal
> _note_ you can also include additional _classifiers_ to a method definition by adding the following notation to the _end_ of the method, i.e.: after the `()`: > _note_ you can also include additional _classifiers_ to a method definition by adding the following notation to the _end_ of the method, i.e.: after the `()`:
>
> - `*` Abstract e.g.: `someAbstractMethod()*` > - `*` Abstract e.g.: `someAbstractMethod()*`
> - `$` Static e.g.: `someStaticMethod()$` > - `$` Static e.g.: `someStaticMethod()$`
> _note_ you can also include additional _classifiers_ to a field definition by adding the following notation to the end of its name: > _note_ you can also include additional _classifiers_ to a field definition by adding the following notation to the end of its name:
>
> - `$` Static e.g.: `String someField$` > - `$` Static e.g.: `String someField$`
## Defining Relationship ## Defining Relationship
A relationship is a general term covering the specific types of logical connections found on class and object diagrams. A relationship is a general term covering the specific types of logical connections found on class and object diagrams.
@ -234,7 +235,6 @@ Here is the syntax:
Where `Relation Type` can be one of: Where `Relation Type` can be one of:
| Type | Description | | Type | Description |
| ---- | ----------- | | ---- | ----------- |
| <\| | Inheritance | | <\| | Inheritance |
@ -282,7 +282,7 @@ classDiagram
## Annotations on classes ## Annotations on classes
It is possible to annotate classes with markers to provide additional metadata about the class. This can give a clearer indication about its nature. Some common annotations include: It is possible to annotate classes with markers to provide additional metadata about the class. This can give a clearer indication about its nature. Some common annotations include:
- `<<Interface>>` To represent an Interface class - `<<Interface>>` To represent an Interface class
- `<<Abstract>>` To represent an abstract class - `<<Abstract>>` To represent an abstract class
@ -355,7 +355,7 @@ classDiagram
} }
Student "1" --o "1" IdCard : carries Student "1" --o "1" IdCard : carries
Student "1" --o "1" Bike : rides Student "1" --o "1" Bike : rides
``` ```
## Interaction ## Interaction
@ -368,6 +368,7 @@ action className "reference" "tooltip"
click className call callback() "tooltip" click className call callback() "tooltip"
click className href "url" "tooltip" click className href "url" "tooltip"
``` ```
- _action_ is either `link` or `callback`, depending on which type of interaction you want to have called - _action_ is either `link` or `callback`, depending on which type of interaction you want to have called
- _className_ is the id of the node that the action will be associated with - _className_ is the id of the node that the action will be associated with
- _reference_ is either the url link, or the function name for callback. - _reference_ is either the url link, or the function name for callback.
@ -398,9 +399,9 @@ click Shape2 call callbackFunction() "This is a tooltip for a callback"
```html ```html
<script> <script>
var callbackFunction = function () { var callbackFunction = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
</script> </script>
``` ```
@ -423,39 +424,19 @@ Beginner's tip—a full example using interactive links in an HTML page:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
classDiagram classDiagram Animal <|-- Duck Animal <|-- Fish Animal <|-- Zebra Animal : +int age Animal :
Animal <|-- Duck +String gender Animal: +isMammal() Animal: +mate() class Duck{ +String beakColor +swim()
Animal <|-- Fish +quack() } class Fish{ -int sizeInFeet -canEat() } class Zebra{ +bool is_wild +run() } callback
Animal <|-- Zebra Duck callback "Tooltip" link Zebra "https://www.github.com" "This is a link"
Animal : +int age
Animal : +String gender
Animal: +isMammal()
Animal: +mate()
class Duck{
+String beakColor
+swim()
+quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+bool is_wild
+run()
}
callback Duck callback "Tooltip"
link Zebra "https://www.github.com" "This is a link"
</div> </div>
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
securityLevel: 'loose' securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
@ -470,11 +451,11 @@ It is possible to apply specific styles such as a thicker border or a different
```html ```html
<style> <style>
.cssClass > rect{ .cssClass > rect {
fill:#FF0000; fill: #ff0000;
stroke:#FFFF00; stroke: #ffff00;
stroke-width:4px; stroke-width: 4px;
} }
</style> </style>
``` ```
@ -509,7 +490,7 @@ classDiagram
?> cssClasses cannot be added using this shorthand method at the same time as a relation statement. ?> cssClasses cannot be added using this shorthand method at the same time as a relation statement.
?> Due to limitations with existing markup for class diagrams, it is not currently possible to define css classes within the diagram itself. ***Coming soon!*** ?> Due to limitations with existing markup for class diagrams, it is not currently possible to define css classes within the diagram itself. **_Coming soon!_**
### Default Styles ### Default Styles
@ -531,91 +512,91 @@ The main styling of the class diagram is done with a preset number of css classe
```scss ```scss
body { body {
background: white; background: white;
} }
g.classGroup text { g.classGroup text {
fill: $nodeBorder; fill: $nodeBorder;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
font-family: var(--mermaid-font-family); font-family: var(--mermaid-font-family);
font-size: 10px; font-size: 10px;
.title { .title {
font-weight: bolder; font-weight: bolder;
} }
} }
g.classGroup rect { g.classGroup rect {
fill: $nodeBkg; fill: $nodeBkg;
stroke: $nodeBorder; stroke: $nodeBorder;
} }
g.classGroup line { g.classGroup line {
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
} }
.classLabel .box { .classLabel .box {
stroke: none; stroke: none;
stroke-width: 0; stroke-width: 0;
fill: $nodeBkg; fill: $nodeBkg;
opacity: 0.5; opacity: 0.5;
} }
.classLabel .label { .classLabel .label {
fill: $nodeBorder; fill: $nodeBorder;
font-size: 10px; font-size: 10px;
} }
.relation { .relation {
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
fill: none; fill: none;
} }
@mixin composition { @mixin composition {
fill: $nodeBorder; fill: $nodeBorder;
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
} }
#compositionStart { #compositionStart {
@include composition; @include composition;
} }
#compositionEnd { #compositionEnd {
@include composition; @include composition;
} }
@mixin aggregation { @mixin aggregation {
fill: $nodeBkg; fill: $nodeBkg;
stroke: $nodeBorder; stroke: $nodeBorder;
stroke-width: 1; stroke-width: 1;
} }
#aggregationStart { #aggregationStart {
@include aggregation; @include aggregation;
} }
#aggregationEnd { #aggregationEnd {
@include aggregation; @include aggregation;
} }
#dependencyStart { #dependencyStart {
@include composition; @include composition;
} }
#dependencyEnd { #dependencyEnd {
@include composition; @include composition;
} }
#extensionStart { #extensionStart {
@include composition; @include composition;
} }
#extensionEnd { #extensionEnd {
@include composition; @include composition;
} }
``` ```

6
src/docs/developer-docs/configuration.md
View File

@ -2,9 +2,9 @@
When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration: When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration:
* The default configuration - The default configuration
* Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**. - Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**.
* Directives - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config. - Directives - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config.
**The render config** is configuration that is used when rendering by applying these configurations. **The render config** is configuration that is used when rendering by applying these configurations.

16
src/docs/development.md
View File

@ -24,9 +24,9 @@ This means that **you should branch off your pull request from develop** and dir
We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows: We make all changes via Pull Requests. As we have many Pull Requests from developers new to mermaid, we have put in place a process, wherein _knsv, Knut Sveidqvist_ is the primary reviewer of changes and merging pull requests. The process is as follows:
- Large changes reviewed by knsv or other developer asked to review by knsv - Large changes reviewed by knsv or other developer asked to review by knsv
- Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators - Smaller, low-risk changes like dependencies, documentation, etc. can be merged by active collaborators
- Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits) - Documentation (we encourage updates to the `src/docs` folder; you can submit them via direct commits)
When you commit code, create a branch with the following naming convention: When you commit code, create a branch with the following naming convention:
@ -82,8 +82,8 @@ This is what a rendering test looks like:
```js ```js
it('should render forks and joins', () => { it('should render forks and joins', () => {
imgSnapshotTest( imgSnapshotTest(
` `
stateDiagram stateDiagram
state fork_state &lt;&lt;fork&gt;&gt; state fork_state &lt;&lt;fork&gt;&gt;
[*] --> fork_state [*] --> fork_state
@ -96,9 +96,9 @@ it('should render forks and joins', () => {
join_state --> State4 join_state --> State4
State4 --> [*] State4 --> [*]
`, `,
{ logLevel: 0 } { logLevel: 0 }
); );
cy.get('svg'); cy.get('svg');
}); });
``` ```

101
src/docs/diagrams-and-syntax-and-examples/flowchart.md
View File

@ -25,20 +25,19 @@ graph LR
Possible FlowChart orientations are: Possible FlowChart orientations are:
* TB - top to bottom - TB - top to bottom
* TD - top-down (same as top to bottom) - TD - top-down (same as top to bottom)
* BT - bottom to top - BT - bottom to top
* RL - right to left - RL - right to left
* LR - left to right - LR - left to right
## Flowcharts ## Flowcharts
This renders a flowchart that allows for features such as: more arrow types, multi directional arrows, and linking to and from subgraphs. This renders a flowchart that allows for features such as: more arrow types, multi directional arrows, and linking to and from subgraphs.
Apart from the graph type, the syntax is the same. This is currently experimental. When the beta period is over, both the graph and flowchart keywords will render in this new way. At this point it is OK to start beta testing flowcharts. Apart from the graph type, the syntax is the same. This is currently experimental. When the beta period is over, both the graph and flowchart keywords will render in this new way. At this point it is OK to start beta testing flowcharts.
> **Important note** Do not type the word "end" as a Flowchart node. Capitalize all or any one the letters to keep the flowchart from breaking, i.e, "End" or "END". Or you can apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897).** > **Important note** Do not type the word "end" as a Flowchart node. Capitalize all or any one the letters to keep the flowchart from breaking, i.e, "End" or "END". Or you can apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897).\*\*
## Nodes and shapes ## Nodes and shapes
@ -105,7 +104,8 @@ graph LR
graph LR graph LR
id1>This is the text in the box] id1>This is the text in the box]
``` ```
Currently it is only possible to render the shape above, and not its mirror. *This might change with future releases.*
Currently it is only possible to render the shape above, and not its mirror. _This might change with future releases._
### A node (rhombus) ### A node (rhombus)
@ -127,6 +127,7 @@ graph LR
graph TD graph TD
id1[/This is the text in the box/] id1[/This is the text in the box/]
``` ```
### Parallelogram alt ### Parallelogram alt
```mermaid-example ```mermaid-example
@ -140,6 +141,7 @@ graph TD
graph TD graph TD
A[/Christmas\] A[/Christmas\]
``` ```
### Trapezoid alt ### Trapezoid alt
```mermaid-example ```mermaid-example
@ -224,23 +226,28 @@ graph LR
### Chaining of links ### Chaining of links
It is possible to declare many links on the same line as per below: It is possible to declare many links on the same line as per below:
```mermaid-example ```mermaid-example
graph LR graph LR
A -- text --> B -- text2 --> C A -- text --> B -- text2 --> C
``` ```
It is also possible to declare multiple nodes links in the same line as per below: It is also possible to declare multiple nodes links in the same line as per below:
```mermaid-example ```mermaid-example
graph LR graph LR
a --> b & c--> d a --> b & c--> d
``` ```
You can then describe dependencies in a very expressive way. Like the one-liner below: You can then describe dependencies in a very expressive way. Like the one-liner below:
```mermaid-example ```mermaid-example
graph TB graph TB
A & B--> C & D A & B--> C & D
``` ```
If you describe the same diagram using the the basic syntax, it will take four lines: If you describe the same diagram using the the basic syntax, it will take four lines:
```mmd ```mmd
graph TB graph TB
A --> C A --> C
@ -248,6 +255,7 @@ graph TB
B --> C B --> C
B --> D B --> D
``` ```
A word of warning, one could go overboard with this, making the graph harder to read in A word of warning, one could go overboard with this, making the graph harder to read in
markdown form. The Swedish word `lagom` comes to mind. It means, not too much and not too little. markdown form. The Swedish word `lagom` comes to mind. It means, not too much and not too little.
This goes for expressive syntaxes as well. This goes for expressive syntaxes as well.
@ -312,12 +320,12 @@ graph TD
For dotted or thick links, the characters to add are equals signs or dots, For dotted or thick links, the characters to add are equals signs or dots,
as summed up in the following table: as summed up in the following table:
| Length | 1 | 2 | 3 | | Length | 1 | 2 | 3 |
|-------------------|:------:|:-------:|:--------:| | ----------------- | :----: | :-----: | :------: |
| Normal | `---` | `----` | `-----` | | Normal | `---` | `----` | `-----` |
| Normal with arrow | `-->` | `--->` | `---->` | | Normal with arrow | `-->` | `--->` | `---->` |
| Thick | `===` | `====` | `=====` | | Thick | `===` | `====` | `=====` |
| Thick with arrow | `==>` | `===>` | `====>` | | Thick with arrow | `==>` | `===>` | `====>` |
| Dotted | `-.-` | `-..-` | `-...-` | | Dotted | `-.-` | `-..-` | `-...-` |
| Dotted with arrow | `-.->` | `-..->` | `-...->` | | Dotted with arrow | `-.->` | `-..->` | `-...->` |
@ -361,7 +369,7 @@ graph TB
subgraph three subgraph three
c1-->c2 c1-->c2
end end
``` ```
You can also set an explicit id for the subgraph: You can also set an explicit id for the subgraph:
@ -371,7 +379,7 @@ graph TB
subgraph ide1 [one] subgraph ide1 [one]
a1-->a2 a1-->a2
end end
``` ```
## Flowcharts ## Flowcharts
@ -392,7 +400,7 @@ flowchart TB
one --> two one --> two
three --> two three --> two
two --> c2 two --> c2
``` ```
## Interaction ## Interaction
@ -403,8 +411,8 @@ click nodeId callback
click nodeId call callback() click nodeId call callback()
``` ```
* nodeId is the id of the node - nodeId is the id of the node
* `callback` is the name of a JavaScript function defined on the page displaying the graph. The function will be called with the nodeId as an incoming parameter. - `callback` is the name of a JavaScript function defined on the page displaying the graph. The function will be called with the nodeId as an incoming parameter.
```html ```html
<script> <script>
@ -428,11 +436,13 @@ graph LR;
click A call callback() "Tooltip for a callback" click A call callback() "Tooltip for a callback"
click B href "https://www.github.com" "This is a tooltip for a link" click B href "https://www.github.com" "This is a tooltip for a link"
``` ```
> **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2. > **Success** The tooltip functionality and the ability to link to urls are available from version 0.5.2.
?> Due to limitations with how Docsify handles JavaScript callback functions, an alternate working demo for the above code can be viewed at [this jsfiddle](https://jsfiddle.net/s37cjoau/3/). ?> Due to limitations with how Docsify handles JavaScript callback functions, an alternate working demo for the above code can be viewed at [this jsfiddle](https://jsfiddle.net/s37cjoau/3/).
Links are opened in the same browser tab/window by default. It is possible to change this by adding a link target to the click definition (`_self`, `_blank`, `_parent` and `_top` are supported): Links are opened in the same browser tab/window by default. It is possible to change this by adding a link target to the click definition (`_self`, `_blank`, `_parent` and `_top` are supported):
```mermaid-example ```mermaid-example
graph LR; graph LR;
A-->B; A-->B;
@ -450,28 +460,23 @@ Beginner's tip—here's a full example of using interactive links in HTML:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
graph LR; graph LR; A-->B; B-->C; C-->D; click A callback "Tooltip" click B "https://www.github.com" "This
A-->B; is a link" click C call callback() "Tooltip" click D href "https://www.github.com" "This is a
B-->C; link"
C-->D;
click A callback "Tooltip"
click B "https://www.github.com" "This is a link"
click C call callback() "Tooltip"
click D href "https://www.github.com" "This is a link"
</div> </div>
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
flowchart: { flowchart: {
useMaxWidth: true, useMaxWidth: true,
htmlLabels: true, htmlLabels: true,
curve: 'cardinal' curve: 'cardinal',
}, },
securityLevel: 'loose' securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
@ -480,7 +485,7 @@ Beginner's tip—here's a full example of using interactive links in HTML:
### Comments ### Comments
Comments can be entered within a flow diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text until the next newline will be treated as a comment, including all punctuation and any flow syntax. Comments can be entered within a flow diagram, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text until the next newline will be treated as a comment, including all punctuation and any flow syntax.
```mmd ```mmd
graph LR graph LR
@ -532,7 +537,6 @@ graph LR
style id2 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff,stroke-dasharray: 5 5 style id2 fill:#bbf,stroke:#f66,stroke-width:2px,color:#fff,stroke-dasharray: 5 5
``` ```
#### Classes #### Classes
More convenient than defining the style every time is to define a class of styles and attach this class reference to multiple nodes. More convenient than defining the style every time is to define a class of styles and attach this class reference to multiple nodes.
@ -563,7 +567,6 @@ graph LR
classDef someclass fill:#f96; classDef someclass fill:#f96;
``` ```
### Css classes ### Css classes
It is also possible to predefine classes in css styles that can be applied from the graph definition: It is also possible to predefine classes in css styles that can be applied from the graph definition:
@ -572,9 +575,9 @@ It is also possible to predefine classes in css styles that can be applied from
```css ```css
.cssClass > rect { .cssClass > rect {
fill: #FF0000; fill: #ff0000;
stroke: #FFFF00; stroke: #ffff00;
stroke-width: 4px; stroke-width: 4px;
} }
``` ```
@ -587,7 +590,6 @@ graph LR;
class A cssClass; class A cssClass;
``` ```
### Default class ### Default class
If a class is named `default` it will be assigned to all nodes that do not have a specific class definition. If a class is named `default` it will be assigned to all nodes that do not have a specific class definition.
@ -596,10 +598,9 @@ If a class is named `default` it will be assigned to all nodes that do not have
classDef default fill:#f9f,stroke:#333,stroke-width:4px; classDef default fill:#f9f,stroke:#333,stroke-width:4px;
``` ```
## Basic support for fontawesome ## Basic support for fontawesome
It is possible to add icons from fontawesome. These are accessed via the syntax fa:#icon-class-name#. It is possible to add icons from fontawesome. These are accessed via the syntax fa:#icon-class-name#.
```mermaid-example ```mermaid-example
graph TD graph TD
@ -609,12 +610,11 @@ graph TD
B-->E(A fa:fa-camera-retro perhaps?); B-->E(A fa:fa-camera-retro perhaps?);
``` ```
## Graph declarations with spaces between vertices and link and without semicolon ## Graph declarations with spaces between vertices and link and without semicolon
* After release 0.2.16, graph declaration statements do not need to end with a semicolon. (And they can continue to have the ending semicolon—it has now just become optional.) So the below graph declaration is valid along with the old declarations. - After release 0.2.16, graph declaration statements do not need to end with a semicolon. (And they can continue to have the ending semicolon—it has now just become optional.) So the below graph declaration is valid along with the old declarations.
* A single space is allowed between vertices and the link, however there should not be any space between a vertex and its text, or a link and its text. The old syntax of graph declarations will also work, so this new feature is optional and is introduced to improve readability. - A single space is allowed between vertices and the link, however there should not be any space between a vertex and its text, or a link and its text. The old syntax of graph declarations will also work, so this new feature is optional and is introduced to improve readability.
Below is an example of the new way to declare graph edges. This is valid alongside any old-style declarations of graph edges. Below is an example of the new way to declare graph edges. This is valid alongside any old-style declarations of graph edges.
@ -626,7 +626,6 @@ graph LR
C -->|Two| E[Result two] C -->|Two| E[Result two]
``` ```
## Configuration... ## Configuration...
Is it possible to adjust the width of the rendered flowchart. Is it possible to adjust the width of the rendered flowchart.
@ -636,6 +635,6 @@ In Javascript config parameters can be set by using `mermaid.flowchartConfig`:
```javascript ```javascript
mermaid.flowchartConfig = { mermaid.flowchartConfig = {
width: '100%' width: '100%',
} };
``` ```

114
src/docs/directives.md
View File

@ -1,38 +1,45 @@
# Directives # Directives
## Directives ## Directives
Directives gives a diagram author the capability to alter the appearance of a diagram before rendering by changing the applied configuration. Directives gives a diagram author the capability to alter the appearance of a diagram before rendering by changing the applied configuration.
The significance of having directives is that you have them available while writing the diagram, and can modify the default global and diagram specific configurations. So, directives are applied on top of the default configurations. The beauty of directives is that you can use them to alter configuration settings for a specific diagram, i.e. at an individual level. The significance of having directives is that you have them available while writing the diagram, and can modify the default global and diagram specific configurations. So, directives are applied on top of the default configurations. The beauty of directives is that you can use them to alter configuration settings for a specific diagram, i.e. at an individual level.
While directives allow you to change most of the default configuration settings, there are some that are not available, that too for security reasons. Also, you do have the *option to define the set of configurations* that you would allow to be available to the diagram author for overriding with help of directives. While directives allow you to change most of the default configuration settings, there are some that are not available, that too for security reasons. Also, you do have the _option to define the set of configurations_ that you would allow to be available to the diagram author for overriding with help of directives.
## Types of Directives options ## Types of Directives options
Mermaid basically supports two types of configuration options to be overridden by directives. Mermaid basically supports two types of configuration options to be overridden by directives.
1) *General/Top Level configurations* : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are:
- theme
- fontFamily
- logLevel
- securityLevel
- startOnLoad
- secure
1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are:
2) *Diagram specific configurations* : These are the configurations that are available and applied to a specific diagram. For each diagram there are specific configuration that will alter how that particular diagram looks and behaves. - theme
For example, `mirrorActors` is a configuration that is specific to the `SequenceDiagram` and alter whether the actors are mirrored or not. So this config is available only for the `SequenceDiagram` type. - fontFamily
- logLevel
- securityLevel
- startOnLoad
- secure
2. _Diagram specific configurations_ : These are the configurations that are available and applied to a specific diagram. For each diagram there are specific configuration that will alter how that particular diagram looks and behaves.
For example, `mirrorActors` is a configuration that is specific to the `SequenceDiagram` and alter whether the actors are mirrored or not. So this config is available only for the `SequenceDiagram` type.
**NOTE:** These options listed here are not all the configuration options. To get hold of all the configuration options, please refer to the [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code. **NOTE:** These options listed here are not all the configuration options. To get hold of all the configuration options, please refer to the [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code.
``` ```
Soon we plan to publish a complete list of top-level configurations & all the diagram specific configurations, Soon we plan to publish a complete list of top-level configurations & all the diagram specific configurations,
with their possible values in the docs with their possible values in the docs
``` ```
## Declaring directives
## Declaring directives
Now that we have defined the types of configurations that are available, we can learn how to declare directives. Now that we have defined the types of configurations that are available, we can learn how to declare directives.
A directive always starts and end `%%` sign with directive text in between, like `%% {directive_text} %%`. A directive always starts and end `%%` sign with directive text in between, like `%% {directive_text} %%`.
Here the structure of a directive text is like a nested key-value pair map or a JSON object with root being *init*. Where all the general configurations are defined in the top level, and all the diagram specific configurations are defined one level deeper with diagram type as key/root for that section. Here the structure of a directive text is like a nested key-value pair map or a JSON object with root being _init_. Where all the general configurations are defined in the top level, and all the diagram specific configurations are defined one level deeper with diagram type as key/root for that section.
Following code snippet shows the structure of a directive: Following code snippet shows the structure of a directive:
``` ```
%%{ %%{
init: { init: {
@ -49,11 +56,15 @@ Following code snippet shows the structure of a directive:
} }
}%% }%%
``` ```
You can also define the directives in a single line, like this: You can also define the directives in a single line, like this:
``` ```
%%{init: { **insert argument here**}}%% %%{init: { **insert argument here**}}%%
``` ```
For example, the following code snippet: For example, the following code snippet:
``` ```
%%{init: { "sequence": { "mirrorActors":false }}}%% %%{init: { "sequence": { "mirrorActors":false }}}%%
``` ```
@ -63,6 +74,7 @@ The json object that is passed as {**argument** } must be valid key value pairs
Valid Key Value pairs can be found in config. Valid Key Value pairs can be found in config.
Example with a simple graph: Example with a simple graph:
```mermaid-example ```mermaid-example
%%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%% %%{init: { 'logLevel': 'debug', 'theme': 'dark' } }%%
graph LR graph LR
@ -85,26 +97,28 @@ parsing the above generates a single `%%init%%` JSON object below, combining the
{ {
logLevel: 'fatal', logLevel: 'fatal',
theme: 'dark', theme: 'dark',
startOnLoad: true startOnLoad: true,
} }
``` ```
This will then be sent to `mermaid.initialize(...)` for rendering. This will then be sent to `mermaid.initialize(...)` for rendering.
## Directive Examples ## Directive Examples
More directive examples for diagram specific configuration overrides More directive examples for diagram specific configuration overrides
Now that the concept of directives has been explained, Let us see some more examples for directives usage: Now that the concept of directives has been explained, Let us see some more examples for directives usage:
### Changing Theme via directive ### Changing Theme via directive
The following code snippet changes theme to forest: The following code snippet changes theme to forest:
`%%{init: { "theme": "forest" } }%%`
```%%{init: { "theme": "forest" } }%%```
Possible themes value are: `default`,`base`, `dark`, `forest` and `neutral`. Possible themes value are: `default`,`base`, `dark`, `forest` and `neutral`.
Default Value is `default`. Default Value is `default`.
Example: Example:
```mermaid-example ```mermaid-example
%%{init: { "theme": "forest" } }%% %%{init: { "theme": "forest" } }%%
graph TD graph TD
@ -118,12 +132,13 @@ A --> C[End]
``` ```
### Changing fontFamily via directive ### Changing fontFamily via directive
The following code snippet changes theme to forest: The following code snippet changes theme to forest:
`%%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%%`
```%%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%%```
Example: Example:
```mermaid-example ```mermaid-example
%%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%% %%{init: { "fontFamily": "Trebuchet MS, Verdana, Arial, Sans-Serif" } }%%
graph TD graph TD
@ -137,21 +152,23 @@ A --> C[End]
``` ```
### Changing logLevel via directive ### Changing logLevel via directive
The following code snippet changes theme to forest: The following code snippet changes theme to forest:
`%%{init: { "logLevel": 2 } }%%`
```%%{init: { "logLevel": 2 } }%%```
Possible logLevel values are: Possible logLevel values are:
- `1` for *debug*,
- `2` for *info* - `1` for _debug_,
- `3` for *warn* - `2` for _info_
- `4` for *error* - `3` for _warn_
- `5` for *only fatal errors* - `4` for _error_
- `5` for _only fatal errors_
Default Value is `5`. Default Value is `5`.
Example: Example:
```mermaid-example ```mermaid-example
%%{init: { "logLevel": 2 } }%% %%{init: { "logLevel": 2 } }%%
graph TD graph TD
@ -164,19 +181,20 @@ A --> C[End]
``` ```
### Changing flowchart config via directive ### Changing flowchart config via directive
Some common flowchart configurations are: Some common flowchart configurations are:
- *htmlLabels*: true/false
- *curve*: linear/curve - _htmlLabels_: true/false
- *diagramPadding*: number - _curve_: linear/curve
- *useMaxWidth*: number - _diagramPadding_: number
- _useMaxWidth_: number
For complete list of flowchart configurations, see [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code. For complete list of flowchart configurations, see [defaultConfig.js](https://github.com/mermaid-js/mermaid/blob/develop/src/defaultConfig.js) in the source code.
*Soon we plan to publish a complete list all diagram specific configurations updated in the docs* _Soon we plan to publish a complete list all diagram specific configurations updated in the docs_
The following code snippet changes flowchart config: The following code snippet changes flowchart config:
`%%{init: { "flowchart": { "htmlLabels": true, "curve": "linear" } } }%%`
```%%{init: { "flowchart": { "htmlLabels": true, "curve": "linear" } } }%%```
Here were are overriding only the flowchart config, and not the general config, where HtmlLabels is set to true and curve is set to linear. Here were are overriding only the flowchart config, and not the general config, where HtmlLabels is set to true and curve is set to linear.
@ -190,19 +208,22 @@ A --> C[End]
C C
end end
``` ```
### Changing Sequence diagram config via directive
Some common sequence configurations are:
- *width*: number
- *height*: number
- *messageAlign*: left, center, right
- *mirrorActors*: boolean
- *useMaxWidth*: boolean
- *rightAngles*: boolean
- *showSequenceNumbers*: boolean
- *wrap*: boolean
For complete list of sequence diagram configurations, see *defaultConfig.js* in the source code. ### Changing Sequence diagram config via directive
*Soon we plan to publish a complete list all diagram specific configurations updated in the docs*
Some common sequence configurations are:
- _width_: number
- _height_: number
- _messageAlign_: left, center, right
- _mirrorActors_: boolean
- _useMaxWidth_: boolean
- _rightAngles_: boolean
- _showSequenceNumbers_: boolean
- _wrap_: boolean
For complete list of sequence diagram configurations, see _defaultConfig.js_ in the source code.
_Soon we plan to publish a complete list all diagram specific configurations updated in the docs_
So, `wrap` by default has a value of `false` for sequence diagrams. So, `wrap` by default has a value of `false` for sequence diagrams.
@ -221,8 +242,7 @@ Now let us enable wrap for sequence diagrams.
The following code snippet changes sequence diagram config for `wrap` to `true`: The following code snippet changes sequence diagram config for `wrap` to `true`:
`%%{init: { "sequence": { "wrap": true} } }%%`
```%%{init: { "sequence": { "wrap": true} } }%%```
Using in the diagram above, the wrap will be enabled. Using in the diagram above, the wrap will be enabled.
@ -234,7 +254,3 @@ Bob->Alice: Fine, How did you mother like the book I suggested? And did you catc
Alice->Bob: Good. Alice->Bob: Good.
Bob->Alice: Cool Bob->Alice: Cool
``` ```

18
src/docs/entityRelationshipDiagram.md
View File

@ -53,10 +53,10 @@ Mermaid syntax for ER diagrams is compatible with PlantUML, with an extension to
Where: Where:
- `first-entity` is the name of an entity. Names must begin with an alphabetic character and may also contain digits, hyphens, and underscores. - `first-entity` is the name of an entity. Names must begin with an alphabetic character and may also contain digits, hyphens, and underscores.
- `relationship` describes the way that both entities inter-relate. See below. - `relationship` describes the way that both entities inter-relate. See below.
- `second-entity` is the name of the other entity. - `second-entity` is the name of the other entity.
- `relationship-label` describes the relationship from the perspective of the first entity. - `relationship-label` describes the relationship from the perspective of the first entity.
For example: For example:
@ -72,9 +72,9 @@ Only the `first-entity` part of a statement is mandatory. This makes it possible
The `relationship` part of each statement can be broken down into three sub-components: The `relationship` part of each statement can be broken down into three sub-components:
- the cardinality of the first entity with respect to the second, - the cardinality of the first entity with respect to the second,
- whether the relationship confers identity on a 'child' entity - whether the relationship confers identity on a 'child' entity
- the cardinality of the second entity with respect to the first - the cardinality of the second entity with respect to the first
Cardinality is a property that describes how many elements of another entity can be related to the entity in question. In the above example a `PROPERTY` can have one or more `ROOM` instances associated to it, whereas a `ROOM` can only be associated with one `PROPERTY`. In each cardinality marker there are two characters. The outermost character represents a maximum value, and the innermost character represents a minimum value. The table below summarises possible cardinalities. Cardinality is a property that describes how many elements of another entity can be related to the entity in question. In the above example a `PROPERTY` can have one or more `ROOM` instances associated to it, whereas a `ROOM` can only be associated with one `PROPERTY`. In each cardinality marker there are two characters. The outermost character represents a maximum value, and the innermost character represents a minimum value. The table below summarises possible cardinalities.
@ -159,8 +159,8 @@ erDiagram
### Other Things ### Other Things
- If you want the relationship label to be more than one word, you must use double quotes around the phrase - If you want the relationship label to be more than one word, you must use double quotes around the phrase
- If you don't want a label at all on a relationship, you must use an empty double-quoted string - If you don't want a label at all on a relationship, you must use an empty double-quoted string
## Styling ## Styling

6
src/docs/examples.md
View File

@ -13,12 +13,14 @@ pie title NETFLIX
"Time spent looking for movie" : 90 "Time spent looking for movie" : 90
"Time spent watching it" : 10 "Time spent watching it" : 10
``` ```
```mermaid-example ```mermaid-example
pie title What Voldemort doesn't have? pie title What Voldemort doesn't have?
"FRIENDS" : 2 "FRIENDS" : 2
"FAMILY" : 3 "FAMILY" : 3
"NOSE" : 45 "NOSE" : 45
``` ```
## Basic sequence diagram ## Basic sequence diagram
```mermaid-example ```mermaid-example
@ -43,7 +45,6 @@ graph LR
C --> D C --> D
``` ```
## Larger flowchart with some styling ## Larger flowchart with some styling
```mermaid-example ```mermaid-example
@ -70,7 +71,6 @@ graph TB
class di orange class di orange
``` ```
## SequenceDiagram: Loops, alt and opt ## SequenceDiagram: Loops, alt and opt
```mermaid-example ```mermaid-example
@ -89,7 +89,6 @@ sequenceDiagram
end end
``` ```
## SequenceDiagram: Message to self in loop ## SequenceDiagram: Message to self in loop
```mermaid-example ```mermaid-example
@ -141,6 +140,7 @@ sequenceDiagram
``` ```
## A commit flow diagram. ## A commit flow diagram.
```mermaid ```mermaid
gitGraph: gitGraph:
commit "Ashish" commit "Ashish"

66
src/docs/flowchart.md
View File

@ -48,11 +48,11 @@ flowchart LR
Possible FlowChart orientations are: Possible FlowChart orientations are:
- TB - top to bottom - TB - top to bottom
- TD - top-down/ same as top to bottom - TD - top-down/ same as top to bottom
- BT - bottom to top - BT - bottom to top
- RL - right to left - RL - right to left
- LR - left to right - LR - left to right
## Node shapes ## Node shapes
@ -433,16 +433,16 @@ click nodeId callback
click nodeId call callback() click nodeId call callback()
``` ```
- nodeId is the id of the node - nodeId is the id of the node
- callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the nodeId as parameter. - callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the nodeId as parameter.
Examples of tooltip usage below: Examples of tooltip usage below:
```html ```html
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
</script> </script>
``` ```
@ -481,23 +481,23 @@ Beginner's tip—a full example using interactive links in a html context:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
flowchart LR A-->B B-->C C-->D click A callback "Tooltip" click B "https://www.github.com" flowchart LR A-->B B-->C C-->D click A callback "Tooltip" click B "https://www.github.com" "This
"This is a link" click C call callback() "Tooltip" click D href "https://www.github.com" is a link" click C call callback() "Tooltip" click D href "https://www.github.com" "This is a
"This is a link" link"
</div> </div>
<script> <script>
var callback = function () { var callback = function () {
alert('A callback was triggered'); alert('A callback was triggered');
}; };
var config = { var config = {
startOnLoad: true, startOnLoad: true,
flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' }, flowchart: { useMaxWidth: true, htmlLabels: true, curve: 'cardinal' },
securityLevel: 'loose', securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
</body> </body>
``` ```
@ -592,11 +592,11 @@ below:
```html ```html
<style> <style>
.cssClass > rect { .cssClass > rect {
fill: #ff0000; fill: #ff0000;
stroke: #ffff00; stroke: #ffff00;
stroke-width: 4px; stroke-width: 4px;
} }
</style> </style>
``` ```
@ -635,9 +635,9 @@ flowchart TD
## Graph declarations with spaces between vertices and link and without semicolon ## Graph declarations with spaces between vertices and link and without semicolon
- In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph. - In graph declarations, the statements also can now end without a semicolon. After release 0.2.16, ending a graph statement with semicolon is just optional. So the below graph declaration is also valid along with the old declarations of the graph.
- A single space is allowed between vertices and the link. However there should not be any space between a vertex and its text and a link and its text. The old syntax of graph declaration will also work and hence this new feature is optional and is introduced to improve readability. - A single space is allowed between vertices and the link. However there should not be any space between a vertex and its text and a link and its text. The old syntax of graph declaration will also work and hence this new feature is optional and is introduced to improve readability.
Below is the new declaration of the graph edges which is also valid along with the old declaration of the graph edges. Below is the new declaration of the graph edges which is also valid along with the old declaration of the graph edges.

157
src/docs/gantt.md
View File

@ -2,18 +2,17 @@
> A Gantt chart is a type of bar chart, first developed by Karol Adamiecki in 1896, and independently by Henry Gantt in the 1910s, that illustrates a project schedule and the amount of time it would take for any one project to finish. Gantt charts illustrate number of days between the start and finish dates of the terminal elements and summary elements of a project. > A Gantt chart is a type of bar chart, first developed by Karol Adamiecki in 1896, and independently by Henry Gantt in the 1910s, that illustrates a project schedule and the amount of time it would take for any one project to finish. Gantt charts illustrate number of days between the start and finish dates of the terminal elements and summary elements of a project.
## A note to users ## A note to users
Gantt Charts will record each scheduled task as one continuous bar that extends from the left to the right. The x axis represents time and the y records the different tasks and the order in which they are to be completed.
Gantt Charts will record each scheduled task as one continuous bar that extends from the left to the right. The x axis represents time and the y records the different tasks and the order in which they are to be completed.
It is important to remember that when a date, day, or collection of dates specific to a task are "excluded", the Gantt Chart will accommodate those changes by extending an equal number of days, towards the right, not by creating a gap inside the task. It is important to remember that when a date, day, or collection of dates specific to a task are "excluded", the Gantt Chart will accommodate those changes by extending an equal number of days, towards the right, not by creating a gap inside the task.
As shown here ![](./img/Gantt-excluded-days-within.png) As shown here ![](./img/Gantt-excluded-days-within.png)
However, if the excluded dates are between two tasks that are set to start consecutively, the excluded dates will be skipped graphically and left blank, and the following task will begin after the end of the excluded dates.
As shown here ![](./img/Gantt-long-weekend-look.png)
However, if the excluded dates are between two tasks that are set to start consecutively, the excluded dates will be skipped graphically and left blank, and the following task will begin after the end of the excluded dates. A Gantt chart is useful for tracking the amount of time it would take before a project is finished, but it can also be used to graphically represent "non-working days", with a few tweaks.
As shown here ![](./img/Gantt-long-weekend-look.png)
A Gantt chart is useful for tracking the amount of time it would take before a project is finished, but it can also be used to graphically represent "non-working days", with a few tweaks.
Mermaid can render Gantt diagrams as SVG, PNG or a MarkDown link that can be pasted into docs. Mermaid can render Gantt diagrams as SVG, PNG or a MarkDown link that can be pasted into docs.
@ -75,37 +74,35 @@ It is possible to set multiple dependencies separated by space:
### Title ### Title
The `title` is an *optional* string to be displayed at the top of the Gantt chart to describe the chart as a whole. The `title` is an _optional_ string to be displayed at the top of the Gantt chart to describe the chart as a whole.
### Section statements ### Section statements
You can divide the chart into various sections, for example to separate different parts of a project like development and documentation. You can divide the chart into various sections, for example to separate different parts of a project like development and documentation.
To do so, start a line with the `section` keyword and give it a name. (Note that unlike with the [title for the entire chart](#title), this name is *required*. To do so, start a line with the `section` keyword and give it a name. (Note that unlike with the [title for the entire chart](#title), this name is _required_.
### Milestones ### Milestones
You can add milestones to the diagrams. Milestones differ from tasks as they represent a single instant in time and are identified by the keyword `milestone`. Below is an example on how to use milestones. As you may notice, the exact location of the milestone is determined by the initial date for the milestone and the "duration" of the task this way: *initial date*+*duration*/2. You can add milestones to the diagrams. Milestones differ from tasks as they represent a single instant in time and are identified by the keyword `milestone`. Below is an example on how to use milestones. As you may notice, the exact location of the milestone is determined by the initial date for the milestone and the "duration" of the task this way: _initial date_+_duration_/2.
```mermaid-example ```mermaid-example
gantt gantt
dateFormat HH:mm dateFormat HH:mm
axisFormat %H:%M axisFormat %H:%M
Initial milestone : milestone, m1, 17:49,2min Initial milestone : milestone, m1, 17:49,2min
taska2 : 10min taska2 : 10min
taska3 : 5min taska3 : 5min
Final milestone : milestone, m2, 18:14, 2min Final milestone : milestone, m2, 18:14, 2min
``` ```
## Setting dates ## Setting dates
`dateFormat` defines the format of the date **input** of your gantt elements. How these dates are represented in the rendered chart **output** are defined by `axisFormat`. `dateFormat` defines the format of the date **input** of your gantt elements. How these dates are represented in the rendered chart **output** are defined by `axisFormat`.
### Input date format ### Input date format
The default input date format is `YYYY-MM-DD`. You can define your custom ``dateFormat``. The default input date format is `YYYY-MM-DD`. You can define your custom `dateFormat`.
``` ```
dateFormat YYYY-MM-DD dateFormat YYYY-MM-DD
@ -140,7 +137,7 @@ More info in: https://momentjs.com/docs/#/parsing/string-format/
### Output date format on the axis ### Output date format on the axis
The default output date format is YYYY-MM-DD. You can define your custom ``axisFormat``, like `2020-Q1` for the first quarter of the year 2020. The default output date format is YYYY-MM-DD. You can define your custom `axisFormat`, like `2020-Q1` for the first quarter of the year 2020.
``` ```
axisFormat %Y-%m-%d axisFormat %Y-%m-%d
@ -201,63 +198,61 @@ Styling of the a gantt diagram is done by defining a number of css classes. Duri
### Classes used ### Classes used
Class | Description | Class | Description |
--- | --- | --------------------- | ---------------------------------------------------------------------- |
grid.tick | Styling for the Grid Lines | grid.tick | Styling for the Grid Lines |
grid.path | Styling for the Grid's borders | grid.path | Styling for the Grid's borders |
.taskText | Task Text Styling | .taskText | Task Text Styling |
.taskTextOutsideRight | Styling for Task Text that exceeds the activity bar towards the right. | .taskTextOutsideRight | Styling for Task Text that exceeds the activity bar towards the right. |
.taskTextOutsideLeft | Styling for Task Text that exceeds the activity bar, towards the left. | .taskTextOutsideLeft | Styling for Task Text that exceeds the activity bar, towards the left. |
todayMarker | Toggle and Styling for the "Today Marker" | todayMarker | Toggle and Styling for the "Today Marker" |
### Sample stylesheet ### Sample stylesheet
```css ```css
.grid .tick { .grid .tick {
stroke: lightgrey; stroke: lightgrey;
opacity: 0.3; opacity: 0.3;
shape-rendering: crispEdges; shape-rendering: crispEdges;
} }
.grid path { .grid path {
stroke-width: 0; stroke-width: 0;
} }
#tag { #tag {
color: white; color: white;
background: #FA283D; background: #fa283d;
width: 150px; width: 150px;
position: absolute; position: absolute;
display: none; display: none;
padding:3px 6px; padding: 3px 6px;
margin-left: -80px; margin-left: -80px;
font-size: 11px; font-size: 11px;
} }
#tag:before { #tag:before {
border: solid transparent; border: solid transparent;
content: ' '; content: ' ';
height: 0; height: 0;
left: 50%; left: 50%;
margin-left: -5px; margin-left: -5px;
position: absolute; position: absolute;
width: 0; width: 0;
border-width: 10px; border-width: 10px;
border-bottom-color: #FA283D; border-bottom-color: #fa283d;
top: -20px; top: -20px;
} }
.taskText { .taskText {
fill:white; fill: white;
text-anchor:middle; text-anchor: middle;
} }
.taskTextOutsideRight { .taskTextOutsideRight {
fill:black; fill: black;
text-anchor:start; text-anchor: start;
} }
.taskTextOutsideLeft { .taskTextOutsideLeft {
fill:black; fill: black;
text-anchor:end; text-anchor: end;
} }
``` ```
@ -286,20 +281,20 @@ mermaid.ganttConfig can be set to a JSON string with config parameters or the co
```javascript ```javascript
mermaid.ganttConfig = { mermaid.ganttConfig = {
titleTopMargin:25, titleTopMargin: 25,
barHeight:20, barHeight: 20,
barGap:4, barGap: 4,
topPadding:75, topPadding: 75,
sidePadding:75 sidePadding: 75,
} };
``` ```
### Possible configuration params: ### Possible configuration params:
Param | Description | Default value | Param | Description | Default value |
--- | --- | --- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
mirrorActor|Turns on/off the rendering of actors below the diagram as well as above it|false | mirrorActor | Turns on/off the rendering of actors below the diagram as well as above it | false |
bottomMarginAdj|Adjusts how far down the graph ended. Wide borders styles with css could generate unwanted clipping which is why this config param exists.|1 | bottomMarginAdj | Adjusts how far down the graph ended. Wide borders styles with css could generate unwanted clipping which is why this config param exists. | 1 |
## Interaction ## Interaction
@ -310,36 +305,30 @@ click taskId call callback(arguments)
click taskId href URL click taskId href URL
``` ```
* taskId is the id of the task - taskId is the id of the task
* callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the taskId as the parameter if no other arguments are specified. - callback is the name of a javascript function defined on the page displaying the graph, the function will be called with the taskId as the parameter if no other arguments are specified.
Beginner's tip—a full example using interactive links in an html context: Beginner's tip—a full example using interactive links in an html context:
```html ```html
<body> <body>
<div class="mermaid"> <div class="mermaid">
gantt gantt dateFormat YYYY-MM-DD section Clickable Visit mermaidjs :active, cl1, 2014-01-07, 3d Print
dateFormat YYYY-MM-DD arguments :cl2, after cl1, 3d Print task :cl3, after cl2, 3d click cl1 href
"https://mermaidjs.github.io/" click cl2 call printArguments("test1", "test2", test3) click cl3
section Clickable call printTask()
Visit mermaidjs :active, cl1, 2014-01-07, 3d
Print arguments :cl2, after cl1, 3d
Print task :cl3, after cl2, 3d
click cl1 href "https://mermaidjs.github.io/"
click cl2 call printArguments("test1", "test2", test3)
click cl3 call printTask()
</div> </div>
<script> <script>
var printArguments = function(arg1, arg2, arg3) { var printArguments = function (arg1, arg2, arg3) {
alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3); alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3);
} };
var printTask = function(taskId) { var printTask = function (taskId) {
alert('taskId: ' + taskId); alert('taskId: ' + taskId);
} };
var config = { var config = {
startOnLoad:true, startOnLoad: true,
securityLevel:'loose', securityLevel: 'loose',
}; };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>

44
src/docs/gitgraph.md
View File

@ -22,10 +22,10 @@ Mermaid can render Git diagrams
In Mermaid, we support the basic git operations like: In Mermaid, we support the basic git operations like:
- _commit_ : Representing a new commit on the current branch. - _commit_ : Representing a new commit on the current branch.
- _branch_ : To create & switch to a new branch, setting it as the current branch. - _branch_ : To create & switch to a new branch, setting it as the current branch.
- _checkout_ : To checking out an existing branch and setting it as the current branch. - _checkout_ : To checking out an existing branch and setting it as the current branch.
- _merge_ : To merge an existing branch onto the current branch. - _merge_ : To merge an existing branch onto the current branch.
With the help of these key git commands, you will be able to draw a gitgraph in Mermaid very easily and quickly. With the help of these key git commands, you will be able to draw a gitgraph in Mermaid very easily and quickly.
Entity names are often capitalized, although there is no accepted standard on this, and it is not required in Mermaid. Entity names are often capitalized, although there is no accepted standard on this, and it is not required in Mermaid.
@ -70,9 +70,9 @@ In this example, we have given our custom IDs to the commits.
In Mermaid, a commit can be of three type, which render a bit different in the diagram. These types are: In Mermaid, a commit can be of three type, which render a bit different in the diagram. These types are:
- `NORMAL` : Default commit type. Represented by a solid circle in the diagram - `NORMAL` : Default commit type. Represented by a solid circle in the diagram
- `REVERSE` : To emphasize a commit as a reverse commit. Represented by a crossed solid circle in the diagram. - `REVERSE` : To emphasize a commit as a reverse commit. Represented by a crossed solid circle in the diagram.
- `HIGHLIGHT` : To highlight a particular commit in the diagram. Represented by a filled rectangle in the diagram. - `HIGHLIGHT` : To highlight a particular commit in the diagram. Represented by a filled rectangle in the diagram.
For a given commit you may specify its type at the time of declaring it using the `type` attribute, followed by `:` and the required type option discussed above. For example: `commit type: HIGHLIGHT` For a given commit you may specify its type at the time of declaring it using the `type` attribute, followed by `:` and the required type option discussed above. For example: `commit type: HIGHLIGHT`
@ -192,9 +192,9 @@ Since the current branch at this point is still `main`, the last two commits are
You can also decorate your merge with similar attributes as you did for the commit using: You can also decorate your merge with similar attributes as you did for the commit using:
- `id`--> To override the default ID with custom ID - `id`--> To override the default ID with custom ID
- `tag`--> To add a custom tag to your merge commit - `tag`--> To add a custom tag to your merge commit
- `type`--> To override the default shape of merge commit. Here you can use other commit type mentioned earlier. - `type`--> To override the default shape of merge commit. Here you can use other commit type mentioned earlier.
And you can choose to use none, some or all of these attributes together. And you can choose to use none, some or all of these attributes together.
For example: `merge develop id: "my_custom_id" tag: "my_custom_tag" type: REVERSE` For example: `merge develop id: "my_custom_id" tag: "my_custom_tag" type: REVERSE`
@ -265,10 +265,10 @@ Let see an example:
In Mermaid, you have the option to configure the gitgraph diagram. You can configure the following options: In Mermaid, you have the option to configure the gitgraph diagram. You can configure the following options:
- `showBranches` : Boolean, default is `true`. If set to `false`, the branches are not shown in the diagram. - `showBranches` : Boolean, default is `true`. If set to `false`, the branches are not shown in the diagram.
- `showCommitLabel` : Boolean, default is `true`. If set to `false`, the commit labels are not shown in the diagram. - `showCommitLabel` : Boolean, default is `true`. If set to `false`, the commit labels are not shown in the diagram.
- `mainBranchName` : String, default is `main`. The name of the default/root branch. - `mainBranchName` : String, default is `main`. The name of the default/root branch.
- `mainBranchOrder` : Position of the main branch in the list of branches. default is `0`, meaning, by default `main` branch is the first in the order. - `mainBranchOrder` : Position of the main branch in the list of branches. default is `0`, meaning, by default `main` branch is the first in the order.
Let's look at them one by one. Let's look at them one by one.
@ -466,9 +466,9 @@ Sometimes you may want to customize the order of the branches. You can do this b
Mermaid follows the given precedence order of the `order` keyword. Mermaid follows the given precedence order of the `order` keyword.
- Main branch is always shown first as it has default order value of `0`. (unless its order is modified and changed from `0` using the `mainBranchOrder` keyword in the config) - Main branch is always shown first as it has default order value of `0`. (unless its order is modified and changed from `0` using the `mainBranchOrder` keyword in the config)
- Next, All branches without an `order` are shown in the order of their appearance in the diagram code. - Next, All branches without an `order` are shown in the order of their appearance in the diagram code.
- Next, All branches with an `order` are shown in the order of their `order` value. - Next, All branches with an `order` are shown in the order of their `order` value.
To fully control the order of all the branches, you must define `order` for all the branches. To fully control the order of all the branches, you must define `order` for all the branches.
@ -514,11 +514,11 @@ Mermaid supports a bunch of pre-defined themes which you can use to find the rig
The following are the different pre-defined theme options: The following are the different pre-defined theme options:
- `base` - `base`
- `forest` - `forest`
- `dark` - `dark`
- `default` - `default`
- `neutral` - `neutral`
**NOTE**: To change theme you can either use the `initialize` call or _directives_. Learn more about [directives](./directives.md) **NOTE**: To change theme you can either use the `initialize` call or _directives_. Learn more about [directives](./directives.md)
Let's put them to use, and see how our sample diagram looks in different themes: Let's put them to use, and see how our sample diagram looks in different themes:

34
src/docs/integrations.md
View File

@ -1,11 +1,11 @@
# Integrations # Integrations
The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions within other applications. The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions within other applications.
They also serve as proof of concept, for the variety of things that can be built with mermaid. They also serve as proof of concept, for the variety of things that can be built with mermaid.
## Productivity ## Productivity
- [GitHub](https://github.com) (**Native support**) - [GitHub](https://github.com) (**Native support**)
- [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) (**Native support**) - [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) (**Native support**)
- [GitHub action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action) - [GitHub action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action)
@ -34,7 +34,7 @@ They also serve as proof of concept, for the variety of things that can be built
## CRM/ERP/Similar ## CRM/ERP/Similar
- [coreBOS](https://blog.corebos.org/blog/december2019) - [coreBOS](https://blog.corebos.org/blog/december2019)
## Blogs ## Blogs
@ -147,22 +147,22 @@ They also serve as proof of concept, for the variety of things that can be built
## Browser Extensions ## Browser Extensions
| Name | Chrome Web Store | Firefox Add-ons | Opera | Edge | Source/Repository | | Name | Chrome Web Store | Firefox Add-ons | Opera | Edge | Source/Repository |
| -- | -- | -- | -- | -- | -- | | ------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
| GitHub + Mermaid | - | [🦊🔗](https://addons.mozilla.org/firefox/addon/github-mermaid/) | - | - | [🐙🔗](https://github.com/BackMarket/github-mermaid-extension) | GitHub + Mermaid | - | [🦊🔗](https://addons.mozilla.org/firefox/addon/github-mermaid/) | - | - | [🐙🔗](https://github.com/BackMarket/github-mermaid-extension) |
| Asciidoctor Live Preview | [🎡🔗](https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia) | - | - | [🌀🔗](https://microsoftedge.microsoft.com/addons/detail/asciidoctorjs-live-previ/pefkelkanablhjdekgdahplkccnbdggd?hl=en-US) | -| | Asciidoctor Live Preview | [🎡🔗](https://chrome.google.com/webstore/detail/asciidoctorjs-live-previe/iaalpfgpbocpdfblpnhhgllgbdbchmia) | - | - | [🌀🔗](https://microsoftedge.microsoft.com/addons/detail/asciidoctorjs-live-previ/pefkelkanablhjdekgdahplkccnbdggd?hl=en-US) | - |
| Diagram Tab| -| - | - | - | [🐙🔗](https://github.com/khafast/diagramtab) | | Diagram Tab | - | - | - | - | [🐙🔗](https://github.com/khafast/diagramtab) |
| Markdown Diagrams| [🎡🔗](https://chrome.google.com/webstore/detail/markdown-diagrams/pmoglnmodacnbbofbgcagndelmgaclel/) | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-diagrams/) | [🔴🔗](https://addons.opera.com/en/extensions/details/markdown-diagrams/) | [🌀🔗](https://microsoftedge.microsoft.com/addons/detail/markdown-diagrams/hceenoomhhdkjjijnmlclkpenkapfihe) | [🐙🔗](https://github.com/marcozaccari/markdown-diagrams-browser-extension/tree/master/doc/examples) | | Markdown Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/markdown-diagrams/pmoglnmodacnbbofbgcagndelmgaclel/) | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-diagrams/) | [🔴🔗](https://addons.opera.com/en/extensions/details/markdown-diagrams/) | [🌀🔗](https://microsoftedge.microsoft.com/addons/detail/markdown-diagrams/hceenoomhhdkjjijnmlclkpenkapfihe) | [🐙🔗](https://github.com/marcozaccari/markdown-diagrams-browser-extension/tree/master/doc/examples) |
| Markdown Viewer| - | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer-chrome/) | - | - | [🐙🔗](https://github.com/simov/markdown-viewer)| | Markdown Viewer | - | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer-chrome/) | - | - | [🐙🔗](https://github.com/simov/markdown-viewer) |
| Extensions for Mermaid| - | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer-chrome/) | [🔴🔗](https://addons.opera.com/en/extensions/details/extensions-for-mermaid/)| - | [🐙🔗](https://github.com/Stefan-S/mermaid-extension) | | Extensions for Mermaid | - | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer-chrome/) | [🔴🔗](https://addons.opera.com/en/extensions/details/extensions-for-mermaid/) | - | [🐙🔗](https://github.com/Stefan-S/mermaid-extension) |
| Chrome Diagrammer| [🎡🔗](https://chrome.google.com/webstore/detail/chrome-diagrammer/bkpbgjmkomfoakfklcjeoegkklgjnnpk) | - |- | - | - | | Chrome Diagrammer | [🎡🔗](https://chrome.google.com/webstore/detail/chrome-diagrammer/bkpbgjmkomfoakfklcjeoegkklgjnnpk) | - | - | - | - |
| Mermaid Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-diagrams/phfcghedmopjadpojhmmaffjmfiakfil) | - | - | - | - | | Mermaid Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-diagrams/phfcghedmopjadpojhmmaffjmfiakfil) | - | - | - | - |
|Mermaid Markdown | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-markdown/mboeoikjijmjcjgpccghbcoegikliijg) | - | - | - | - | | Mermaid Markdown | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-markdown/mboeoikjijmjcjgpccghbcoegikliijg) | - | - | - | - |
| Monkeys | [🎡🔗](https://chrome.google.com/webstore/detail/monkeys-mermaid-for-githu/cplfdpoajbclbgphaphphcldamfkjlgi) | - | - | - | - | | Monkeys | [🎡🔗](https://chrome.google.com/webstore/detail/monkeys-mermaid-for-githu/cplfdpoajbclbgphaphphcldamfkjlgi) | - | - | - | - |
| Mermaid Previewer | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-previewer/oidjnlhbegipkcklbdfnbkikplpghfdl) | - | - | - | - | | Mermaid Previewer | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-previewer/oidjnlhbegipkcklbdfnbkikplpghfdl) | - | - | - | - |
## Other ## Other
- [Jekyll](https://jekyllrb.com/) - [Jekyll](https://jekyllrb.com/)
- [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid) - [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid)
- [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams) - [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams)

50
src/docs/landing/index.html
View File

@ -49,16 +49,7 @@
<div class="pt-24"> <div class="pt-24">
<div <div
style="" style=""
class=" class="container lg:px-24 max-w-5xl px-4 mx-auto flex flex-wrap flex-col md:flex-row items-center"
container
lg:px-24
max-w-5xl
px-4
mx-auto
flex flex-wrap flex-col
md:flex-row
items-center
"
> >
<!--Left Col--> <!--Left Col-->
<div class="w-full md:w-1/2"> <div class="w-full md:w-1/2">
@ -77,24 +68,7 @@
> >
<button <button
style="background: #ffa41c; border: 1px solid #ff8f00" style="background: #ffa41c; border: 1px solid #ff8f00"
class=" class="mx-auto lg:mx-0 hover:underline text-black font-bold rounded-full my-6 py-4 px-8 shadow-lg focus:outline-none focus:shadow-outline transform transition hover:scale-105 duration-300 ease-in-out"
mx-auto
lg:mx-0
hover:underline
text-black
font-bold
rounded-full
my-6
py-4
px-8
shadow-lg
focus:outline-none focus:shadow-outline
transform
transition
hover:scale-105
duration-300
ease-in-out
"
> >
Purchase on Amazon Purchase on Amazon
</button> </button>
@ -352,25 +326,7 @@
> >
<button <button
style="background: #ffa41c; border: 1px solid #ff8f00" style="background: #ffa41c; border: 1px solid #ff8f00"
class=" class="mx-auto lg:mx-0 hover:underline bg-white text-gray-800 font-bold rounded-full my-6 py-4 px-8 shadow-lg focus:outline-none focus:shadow-outline transform transition hover:scale-105 duration-300 ease-in-out"
mx-auto
lg:mx-0
hover:underline
bg-white
text-gray-800
font-bold
rounded-full
my-6
py-4
px-8
shadow-lg
focus:outline-none focus:shadow-outline
transform
transition
hover:scale-105
duration-300
ease-in-out
"
> >
Purchase Now on Amazon Purchase Now on Amazon
</button> </button>

3
src/docs/n00b-advanced.md
View File

@ -1,6 +1,7 @@
# Advanced n00b mermaid (Coming soon..) # Advanced n00b mermaid (Coming soon..)
## splitting mermaid code from html ## splitting mermaid code from html
A more condensed html code can be achieved by embedding the mermaid code in its own .js file, which is referenced like so: A more condensed html code can be achieved by embedding the mermaid code in its own .js file, which is referenced like so:
``` ```
@ -9,11 +10,13 @@ stuff stuff
</body> </body>
</html> </html>
``` ```
The actual mermaid file could for example look like this: The actual mermaid file could for example look like this:
``` ```
mermaid content... mermaid content...
``` ```
--- ---
## mermaid configuration options ## mermaid configuration options

91
src/docs/n00b-gettingStarted.md
View File

@ -85,7 +85,7 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an
```html ```html
<body> <body>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
</body> </body>
``` ```
@ -93,13 +93,10 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an
```html ```html
<body> <body>
Here is a mermaid diagram: Here is a mermaid diagram:
<div class="mermaid"> <div class="mermaid">
graph TD graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02]
A[Client] --> B[Load Balancer] </div>
B --> C[Server01]
B --> D[Server02]
</div>
</body> </body>
``` ```
@ -111,9 +108,9 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an
```html ```html
<body> <body>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
</body> </body>
``` ```
@ -132,29 +129,23 @@ Rendering in Mermaid is initialized by `mermaid.initialize()` call. You can plac
```html ```html
<html> <html>
<body> <body>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
Here is one mermaid diagram: Here is one mermaid diagram:
<div class="mermaid"> <div class="mermaid">
graph TD graph TD A[Client] --> B[Load Balancer] B --> C[Server1] B --> D[Server2]
A[Client] --> B[Load Balancer] </div>
B --> C[Server1]
B --> D[Server2]
</div>
And here is another: And here is another:
<div class="mermaid"> <div class="mermaid">
graph TD graph TD A[Client] -->|tcp_123| B B(Load Balancer) B -->|tcp_456| C[Server1] B -->|tcp_456|
A[Client] -->|tcp_123| B D[Server2]
B(Load Balancer) </div>
B -->|tcp_456| C[Server1] </body>
B -->|tcp_456| D[Server2]
</div>
</body>
</html> </html>
``` ```
@ -163,27 +154,19 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file,
```html ```html
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
</head> </head>
<body> <body>
<div class="mermaid"> <div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div>
graph LR <div class="mermaid">
A --- B graph TD A[Client] --> B[Load Balancer] B --> C[Server1] B --> D[Server2]
B-->C[fa:fa-ban forbidden] </div>
B-->D(fa:fa-spinner); <script src="The\Path\In\Your\Package\mermaid.js"></script>
</div> <script>
<div class="mermaid"> mermaid.initialize({ startOnLoad: true });
graph TD </script>
A[Client] --> B[Load Balancer] </body>
B --> C[Server1]
B --> D[Server2]
</div>
<script src="The\Path\In\Your\Package\mermaid.js"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>
</body>
</html> </html>
``` ```
@ -204,4 +187,4 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file,
**Comments from Knut Sveidqvist, creator of mermaid:** **Comments from Knut Sveidqvist, creator of mermaid:**
- In early versions of mermaid, the `<script src>` tag was invoked in the `<head>` part of the web page. Nowadays we can place it in the `<body>` as seen above. Older parts of the documentation frequently reflects the previous way which still works. - In early versions of mermaid, the `<script src>` tag was invoked in the `<head>` part of the web page. Nowadays we can place it in the `<body>` as seen above. Older parts of the documentation frequently reflects the previous way which still works.

22
src/docs/n00b-overview.md
View File

@ -12,7 +12,7 @@ Diagrams/Charts are significant but also become obsolete/inaccurate very fast. T
# Doc Rot in Diagrams # Doc Rot in Diagrams
Doc-Rot kills diagrams as quickly as it does text, but it takes hours in a desktop application to produce a diagram. Doc-Rot kills diagrams as quickly as it does text, but it takes hours in a desktop application to produce a diagram.
Mermaid seeks to change using markdown-inspired syntax. The process is a quicker, less complicated, and more convenient way of going from concept to visualization. Mermaid seeks to change using markdown-inspired syntax. The process is a quicker, less complicated, and more convenient way of going from concept to visualization.
@ -22,25 +22,21 @@ It is a relatively straightforward solution to a significant hurdle with the sof
**Mermaid text definitions can be saved for later reuse and editing.** **Mermaid text definitions can be saved for later reuse and editing.**
>These are the Mermaid diagram definitions inside `<div>` tags, with the `class=mermaid`. > These are the Mermaid diagram definitions inside `<div>` tags, with the `class=mermaid`.
```html ```html
<div class="mermaid"> <div class="mermaid">
graph TD graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02]
A[Client] --> B[Load Balancer] </div>
B --> C[Server01]
B --> D[Server02]
</div>
``` ```
**render** **render**
>This is the core function of the Mermaid API. It reads all the `Mermaid Definitions` inside `div` tags and returns an SVG file, based on the definition. > This is the core function of the Mermaid API. It reads all the `Mermaid Definitions` inside `div` tags and returns an SVG file, based on the definition.
**Nodes** **Nodes**
>These are the boxes that contain text or otherwise discrete pieces of each diagram, separated generally by arrows, except for Gantt Charts and User Journey Diagrams. They will be referred often in the instructions. Read for Diagram Specific [Syntax](./n00b-syntaxReference) > These are the boxes that contain text or otherwise discrete pieces of each diagram, separated generally by arrows, except for Gantt Charts and User Journey Diagrams. They will be referred often in the instructions. Read for Diagram Specific [Syntax](./n00b-syntaxReference)
## Advantages of using Mermaid ## Advantages of using Mermaid
@ -57,13 +53,13 @@ Mermaid solves this by reducing the time and effort required to create diagrams
Because, the text base for the diagrams allows it to be updated easily. Also, it can be made part of production scripts (and other pieces of code). So less time is spent on documenting, as a separate task. Because, the text base for the diagrams allows it to be updated easily. Also, it can be made part of production scripts (and other pieces of code). So less time is spent on documenting, as a separate task.
## Catching up with Development ## Catching up with Development
Being based on markdown, Mermaid can be used, not only by accomplished front-end developers, but by most computer savvy people to render diagrams, at much faster speeds. Being based on markdown, Mermaid can be used, not only by accomplished front-end developers, but by most computer savvy people to render diagrams, at much faster speeds.
In fact one can pick up the syntax for it quite easily from the examples given and there are many tutorials available in the internet. In fact one can pick up the syntax for it quite easily from the examples given and there are many tutorials available in the internet.
## Mermaid is for everyone. ## Mermaid is for everyone.
Video [Tutorials](https://mermaid-js.github.io/mermaid/#/./Tutorials) are also available for the mermaid [live editor](https://mermaid.live/). Video [Tutorials](https://mermaid-js.github.io/mermaid/#/./Tutorials) are also available for the mermaid [live editor](https://mermaid.live/).
Alternatively you can use Mermaid [Plug-Ins](https://mermaid-js.github.io/mermaid/#/./integrations), with tools you already use, like Google Docs. Alternatively you can use Mermaid [Plug-Ins](https://mermaid-js.github.io/mermaid/#/./integrations), with tools you already use, like Google Docs.

54
src/docs/n00b-syntaxReference.md
View File

@ -1,12 +1,14 @@
# Diagram Syntax # Diagram Syntax
Mermaid's syntax is used to create diagrams. You'll find that it is not too tricky and can be learned in a day. The next sections dive deep into the syntax of each diagram type.
Syntax, together with Deployment and Configuration constitute the whole of Mermaid. Mermaid's syntax is used to create diagrams. You'll find that it is not too tricky and can be learned in a day. The next sections dive deep into the syntax of each diagram type.
Syntax, together with Deployment and Configuration constitute the whole of Mermaid.
Diagram Examples can be found in the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor), it is also a great practice area. Diagram Examples can be found in the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor), it is also a great practice area.
## Syntax Structure ## Syntax Structure
One would notice that all **Diagrams definitions begin** with a declaration of the **diagram type**, followed by the definitions of the diagram and its contents. This declaration notifies the parser which kind of diagram the code is supposed to generate.
One would notice that all **Diagrams definitions begin** with a declaration of the **diagram type**, followed by the definitions of the diagram and its contents. This declaration notifies the parser which kind of diagram the code is supposed to generate.
**Example** : The code below is for an Entity Relationship Diagram, specified by the `erDiagram` declaration. What follows is the definition of the different `Entities` represented in it. **Example** : The code below is for an Entity Relationship Diagram, specified by the `erDiagram` declaration. What follows is the definition of the different `Entities` represented in it.
@ -22,56 +24,44 @@ erDiagram
PRODUCT ||--o{ ORDER-ITEM : "ordered in" PRODUCT ||--o{ ORDER-ITEM : "ordered in"
``` ```
The [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax. The [Getting Started](./n00b-gettingStarted.md) section can also provide some practical examples of mermaid syntax.
## Diagram Breaking ## Diagram Breaking
One should **beware the use of some words or symbols** that can break diagrams. These words or symbols are few and often only affect specific types of diagrams. The table below will continuously be updated. One should **beware the use of some words or symbols** that can break diagrams. These words or symbols are few and often only affect specific types of diagrams. The table below will continuously be updated.
| Diagram Breakers | Reason | Solution |
| Diagram Breakers | Reason |Solution| | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------- |
| --- | --- |---| | **Comments** | | |
| **Comments** | | | | [` %%{``}%% `](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer. | In comments using `%%`, avoid using "{}". |
|[`%%{``}%%`](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer.|In comments using `%%`, avoid using "{}".| | **Flow-Charts** | | |
| **Flow-Charts** | | | | 'end' | The word "End" can cause Flowcharts and Sequence diagrams to break | Wrap them in quotation marks to prevent breakage. |
|'end' | The word "End" can cause Flowcharts and Sequence diagrams to break | Wrap them in quotation marks to prevent breakage.| | [Nodes inside Nodes](https://mermaid-js.github.io/mermaid/#/flowchart?id=special-characters-that-break-syntax) | Mermaid gets confused with nested shapes | wrap them in quotation marks to prevent breaking |
| [Nodes inside Nodes](https://mermaid-js.github.io/mermaid/#/flowchart?id=special-characters-that-break-syntax)| Mermaid gets confused with nested shapes | wrap them in quotation marks to prevent breaking|
### Mermaid Live Editor ### Mermaid Live Editor
Now, that you've seen what you should not add to your diagrams, you can play around with them in the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor).
Now, that you've seen what you should not add to your diagrams, you can play around with them in the [Mermaid Live Editor](https://mermaid-js.github.io/mermaid-live-editor).
# Configuration # Configuration
Configuration is the third part of Mermaid, after deployment and syntax. It deals with the different ways that Mermaid can be customized across different deployments. Configuration is the third part of Mermaid, after deployment and syntax. It deals with the different ways that Mermaid can be customized across different deployments.
If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](./Setup.md) here. It includes themes. If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for [Configuration](./Setup.md) here. It includes themes.
This section will introduce the different methods of configuring the behaviors and appearances of Mermaid Diagrams. This section will introduce the different methods of configuring the behaviors and appearances of Mermaid Diagrams.
The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods. The following are the most commonly used methods, and they are all tied to Mermaid [Deployment](./n00b-gettingStarted.md) methods.
### Configuration Section in the [Live Editor](https://mermaid-js.github.io/mermaid-live-editor). ### Configuration Section in the [Live Editor](https://mermaid-js.github.io/mermaid-live-editor).
Here you can edit certain values to change the behavior and appearance of the diagram. Here you can edit certain values to change the behavior and appearance of the diagram.
### [The initialize() call](https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted?id=_3-calling-the-javascript-api), ### [The initialize() call](https://mermaid-js.github.io/mermaid/#/n00b-gettingStarted?id=_3-calling-the-javascript-api),
Used when Mermaid is called via an API, or through a `<script>` tag.
Used when Mermaid is called via an API, or through a `<script>` tag.
### [Directives](./directives.md), ### [Directives](./directives.md),
Allows for the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. You can pass a directive alongside your definition inside `%%{ }%%`. It can be done either above or below your diagram definition.
Allows for the limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. You can pass a directive alongside your definition inside `%%{ }%%`. It can be done either above or below your diagram definition.
### [Theme Manipulation](./theming.md): ### [Theme Manipulation](./theming.md):
An application of using Directives to change [Themes](./theming.md). `Theme` is a value within Mermaid's configuration that dictates the color scheme for diagrams.
An application of using Directives to change [Themes](./theming.md). `Theme` is a value within Mermaid's configuration that dictates the color scheme for diagrams.

68
src/docs/newDiagram.md
View File

@ -2,15 +2,14 @@
### Step 1: Grammar & Parsing ### Step 1: Grammar & Parsing
#### Grammar #### Grammar
This would be to define a jison grammar for the new diagram type. That should start with a way to identify that the text in the mermaid tag is a diagram of that type. Create a new folder under diagrams for your new diagram type and a parser folder in it. This leads us to step 2. This would be to define a jison grammar for the new diagram type. That should start with a way to identify that the text in the mermaid tag is a diagram of that type. Create a new folder under diagrams for your new diagram type and a parser folder in it. This leads us to step 2.
For instance: For instance:
* the flowchart starts with the keyword graph. - the flowchart starts with the keyword graph.
* the sequence diagram starts with the keyword sequenceDiagram - the sequence diagram starts with the keyword sequenceDiagram
#### Store data found during parsing #### Store data found during parsing
@ -36,74 +35,67 @@ For more info look in the example diagram type:
The `yy` object has the following function: The `yy` object has the following function:
```javascript ```javascript
exports.parseError = function(err, hash){ exports.parseError = function (err, hash) {
mermaid.parseError(err, hash) mermaid.parseError(err, hash);
}; };
``` ```
when parsing the `yy` object is initialized as per below: when parsing the `yy` object is initialized as per below:
```javascript ```javascript
var parser var parser;
parser = exampleParser.parser parser = exampleParser.parser;
parser.yy = db parser.yy = db;
``` ```
### Step 2: Rendering ### Step 2: Rendering
Write a renderer that given the data found during parsing renders the diagram. To look at an example look at sequenceRenderer.js rather then the flowchart renderer as this is a more generic example. Write a renderer that given the data found during parsing renders the diagram. To look at an example look at sequenceRenderer.js rather then the flowchart renderer as this is a more generic example.
Place the renderer in the diagram folder. Place the renderer in the diagram folder.
### Step 3: Detection of the new diagram type ### Step 3: Detection of the new diagram type
The second thing to do is to add the capability to detect the new new diagram to type to the detectType in utils.js. The detection should return a key for the new diagram type. The second thing to do is to add the capability to detect the new new diagram to type to the detectType in utils.js. The detection should return a key for the new diagram type.
### Step 4: The final piece - triggering the rendering ### Step 4: The final piece - triggering the rendering
At this point when mermaid is trying to render the diagram, it will detect it as being of the new type but there will be no match when trying to render the diagram. To fix this add a new case in the switch statement in main.js:init this should match the diagram type returned from step #2. The code in this new case statement should call the renderer for the diagram type with the data found by the parser as an argument. At this point when mermaid is trying to render the diagram, it will detect it as being of the new type but there will be no match when trying to render the diagram. To fix this add a new case in the switch statement in main.js:init this should match the diagram type returned from step #2. The code in this new case statement should call the renderer for the diagram type with the data found by the parser as an argument.
## Usage of the parser as a separate module ## Usage of the parser as a separate module
### Setup ### Setup
```javascript ```javascript
var graph = require('./graphDb') var graph = require('./graphDb');
var flow = require('./parser/flow') var flow = require('./parser/flow');
flow.parser.yy = graph flow.parser.yy = graph;
``` ```
### Parsing ### Parsing
```javascript ```javascript
flow.parser.parse(text) flow.parser.parse(text);
``` ```
### Data extraction ### Data extraction
```javascript ```javascript
graph.getDirection() graph.getDirection();
graph.getVertices() graph.getVertices();
graph.getEdges() graph.getEdges();
``` ```
The parser is also exposed in the mermaid api by calling: The parser is also exposed in the mermaid api by calling:
```javascript ```javascript
var parser = mermaid.getParser() var parser = mermaid.getParser();
``` ```
Note that the parse needs a graph object to store the data as per: Note that the parse needs a graph object to store the data as per:
```javascript ```javascript
flow.parser.yy = graph flow.parser.yy = graph;
``` ```
Look at `graphDb.js` for more details on that object. Look at `graphDb.js` for more details on that object.
@ -116,10 +108,10 @@ If you are using a dagre based layout, please use flowchart-v2 as a template and
There are a few features that are common between the different types of diagrams. We try to standardize the diagrams that work as similar as possible for the end user. The commonalities are: There are a few features that are common between the different types of diagrams. We try to standardize the diagrams that work as similar as possible for the end user. The commonalities are:
* Directives, a way of modifying the diagram configuration from within the diagram code. - Directives, a way of modifying the diagram configuration from within the diagram code.
* Accessibility, a way for an author to provide additional information like titles and descriptions to people accessing a text with diagrams using a screen reader. - Accessibility, a way for an author to provide additional information like titles and descriptions to people accessing a text with diagrams using a screen reader.
* Themes, there is a common way to modify the styling of diagrams in Mermaid. - Themes, there is a common way to modify the styling of diagrams in Mermaid.
* Comments should follow mermaid standards - Comments should follow mermaid standards
Here some pointers on how to handle these different areas. Here some pointers on how to handle these different areas.
@ -127,6 +119,7 @@ Here some pointers on how to handle these different areas.
Here is example handling from flowcharts: Here is example handling from flowcharts:
Jison: Jison:
```jison ```jison
/* lexical grammar */ /* lexical grammar */
@ -173,6 +166,7 @@ It is probably a good idea to keep the handling similar to this in your new diag
## Accessibility ## Accessibility
The syntax for adding title and description looks like this: The syntax for adding title and description looks like this:
``` ```
accTitle: The title accTitle: The title
accDescr: The description accDescr: The description
@ -222,6 +216,7 @@ import {
For rendering the accessibility tags you have again an existing function you can use. For rendering the accessibility tags you have again an existing function you can use.
**In the renderer:** **In the renderer:**
```js ```js
import addSVGAccessibilityFields from '../../accessibility'; import addSVGAccessibilityFields from '../../accessibility';
@ -239,11 +234,11 @@ When adding themes to a diagram it comes down to a few important locations in th
The entry point for the styling engine is in **src/styles.js**. The getStyles function will be called by Mermaid when the styles are being applied to the diagram. The entry point for the styling engine is in **src/styles.js**. The getStyles function will be called by Mermaid when the styles are being applied to the diagram.
This function will in turn call a function *your diagram should provide* returning the css for the new diagram. The diagram specific, also which is commonly also called getStyles and located in the folder for your diagram under src/diagrams and should be named styles.js. The getStyles function will be called with the theme options as an argument like in the following example: This function will in turn call a function _your diagram should provide_ returning the css for the new diagram. The diagram specific, also which is commonly also called getStyles and located in the folder for your diagram under src/diagrams and should be named styles.js. The getStyles function will be called with the theme options as an argument like in the following example:
```js ```js
const getStyles = (options) => const getStyles = (options) =>
` `
.line { .line {
stroke-width: 1; stroke-width: 1;
stroke: ${options.lineColor}; stroke: ${options.lineColor};
@ -253,17 +248,16 @@ const getStyles = (options) =>
`; `;
``` ```
Note that you need to provide your function to the main getStyles by adding it into the themes object in **src/styles.js** like in the xyzDiagram in the provided example: Note that you need to provide your function to the main getStyles by adding it into the themes object in **src/styles.js** like in the xyzDiagram in the provided example:
```js ```js
const themes = { const themes = {
flowchart, flowchart,
'flowchart-v2': flowchart, 'flowchart-v2': flowchart,
sequence, sequence,
xyzDiagram, xyzDiagram,
//... //...
}; };
``` ```
The actual options and values for the colors are defined in **src/theme/theme-[xyz].js**. If you provide the options your diagram needs in the existing theme files then the theming will work smoothly without hiccups. The actual options and values for the colors are defined in **src/theme/theme-[xyz].js**. If you provide the options your diagram needs in the existing theme files then the theming will work smoothly without hiccups.

28
src/docs/pie.md
View File

@ -1,7 +1,7 @@
# Pie chart diagrams # Pie chart diagrams
> A pie chart (or a circle chart) is a circular statistical graphic, which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area), is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. The earliest known pie chart is generally credited to William Playfair's Statistical Breviary of 1801 > A pie chart (or a circle chart) is a circular statistical graphic, which is divided into slices to illustrate numerical proportion. In a pie chart, the arc length of each slice (and consequently its central angle and area), is proportional to the quantity it represents. While it is named for its resemblance to a pie which has been sliced, there are variations on the way it can be presented. The earliest known pie chart is generally credited to William Playfair's Statistical Breviary of 1801
-Wikipedia > -Wikipedia
Mermaid can render Pie Chart diagrams. Mermaid can render Pie Chart diagrams.
@ -12,26 +12,28 @@ pie title Pets adopted by volunteers
"Rats" : 15 "Rats" : 15
``` ```
## Syntax ## Syntax
Drawing a pie chart is really simple in mermaid. Drawing a pie chart is really simple in mermaid.
- Start with `pie` keyword to begin the diagram - Start with `pie` keyword to begin the diagram
- `showData` to render the actual data values after the legend text. This is ***OPTIONAL*** - `showData` to render the actual data values after the legend text. This is **_OPTIONAL_**
- Followed by `title` keyword and its value in string to give a title to the pie-chart. This is ***OPTIONAL*** - Followed by `title` keyword and its value in string to give a title to the pie-chart. This is **_OPTIONAL_**
- Followed by dataSet - Followed by dataSet
- `label` for a section in the pie diagram within `" "` quotes. - `label` for a section in the pie diagram within `" "` quotes.
- Followed by `:` colon as separator - Followed by `:` colon as separator
- Followed by `positive numeric value` (supported upto two decimal places) - Followed by `positive numeric value` (supported upto two decimal places)
[pie] [showData] (OPTIONAL) [pie] [showData] (OPTIONAL)
[title] [titlevalue] (OPTIONAL) [title] [titlevalue] (OPTIONAL)
"[datakey1]" : [dataValue1] "[datakey1]" : [dataValue1]
"[datakey2]" : [dataValue2] "[datakey2]" : [dataValue2]
"[datakey3]" : [dataValue3] "[datakey3]" : [dataValue3]
. .
. .
## Example ## Example
```mermaid-example ```mermaid-example
pie showData pie showData
title Key elements in Product X title Key elements in Product X

19
src/docs/requirementDiagram.md
View File

@ -25,11 +25,12 @@ Rendering requirements is straightforward.
There are three types of components to a requirement diagram: requirement, element, and relationship. There are three types of components to a requirement diagram: requirement, element, and relationship.
The grammar for defining each is defined below. Words denoted in angle brackets, such as ```<word>```, are enumerated keywords that have options elaborated in a table. ```user_defined_...``` is use in any place where user input is expected. The grammar for defining each is defined below. Words denoted in angle brackets, such as `<word>`, are enumerated keywords that have options elaborated in a table. `user_defined_...` is use in any place where user input is expected.
An important note on user text: all input can be surrounded in quotes or not. For example, both ```Id: "here is an example"``` and ```Id: here is an example``` are both valid. However, users must be careful with unquoted input. The parser will fail if another keyword is detected. An important note on user text: all input can be surrounded in quotes or not. For example, both `Id: "here is an example"` and `Id: here is an example` are both valid. However, users must be careful with unquoted input. The parser will fail if another keyword is detected.
### Requirement ### Requirement
A requirement definition contains a requirement type, name, id, text, risk, and verification method. The syntax follows: A requirement definition contains a requirement type, name, id, text, risk, and verification method. The syntax follows:
``` ```
@ -43,13 +44,14 @@ A requirement definition contains a requirement type, name, id, text, risk, and
Type, risk, and method are enumerations defined in SysML. Type, risk, and method are enumerations defined in SysML.
| Keyword | Options | | Keyword | Options |
|---|---| | ------------------ | ----------------------------------------------------------------------------------------------------------------------- |
| Type | requirement, functionalRequirement, interfaceRequirement, performanceRequirement, physicalRequirement, designConstraint | | Type | requirement, functionalRequirement, interfaceRequirement, performanceRequirement, physicalRequirement, designConstraint |
| Risk | Low, Medium, High | | Risk | Low, Medium, High |
| VerificationMethod | Analysis, Inspection, Test, Demonstration | | VerificationMethod | Analysis, Inspection, Test, Demonstration |
### Element ### Element
An element definition contains an element name, type, and document reference. These three are all user defined. The element feature is intended to be lightweight but allow requirements to be connected to portions of other documents. An element definition contains an element name, type, and document reference. These three are all user defined. The element feature is intended to be lightweight but allow requirements to be connected to portions of other documents.
``` ```
@ -59,8 +61,8 @@ element user_defined_name {
} }
``` ```
### Relationship ### Relationship
Relationships are comprised of a source node, destination node, and relationship type. Relationships are comprised of a source node, destination node, and relationship type.
Each follows the definition format of Each follows the definition format of
@ -82,6 +84,7 @@ A relationship type can be one of contains, copies, derives, satisfies, verifies
Each relationship is labeled in the diagram. Each relationship is labeled in the diagram.
## Larger Example ## Larger Example
This example uses all features of the diagram. This example uses all features of the diagram.
```mermaid-example ```mermaid-example

5
src/docs/security.md
View File

@ -1,7 +1,9 @@
# Security # Security
The Mermaid team takes the security of Mermaid and the applications that use Mermaid seriously. This page describes how to report any vulnerabilities you may find, and lists best practices to minimize the risk of introducing a vulnerability. The Mermaid team takes the security of Mermaid and the applications that use Mermaid seriously. This page describes how to report any vulnerabilities you may find, and lists best practices to minimize the risk of introducing a vulnerability.
## Reporting vulnerabilities ## 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. 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.
We aim to reply within three working days, probably much sooner. We aim to reply within three working days, probably much sooner.
@ -16,7 +18,6 @@ Keep current with the latest Mermaid releases. We regularly update Mermaid, and
Keep your application’s dependencies up to date. Make sure you upgrade your package dependencies to keep the dependencies up to date. Avoid pinning to specific versions for your dependencies and, if you do, make sure you check periodically to see if your dependencies have had security updates, and update the pin accordingly. Keep your application’s dependencies up to date. Make sure you upgrade your package dependencies to keep the dependencies up to date. Avoid pinning to specific versions for your dependencies and, if you do, make sure you check periodically to see if your dependencies have had security updates, and update the pin accordingly.
## Configuring DomPurify ## Configuring DomPurify
By default Mermaid uses a baseline [DOMPurify](https://github.com/cure53/DOMPurify) config. It is possible to override the options passed to DOMPurify by adding a `dompurifyConfig` key to the Mermaid options. This could potentially break the output of Mermaid so use this with caution. By default Mermaid uses a baseline [DOMPurify](https://github.com/cure53/DOMPurify) config. It is possible to override the options passed to DOMPurify by adding a `dompurifyConfig` key to the Mermaid options. This could potentially break the output of Mermaid so use this with caution.

88
src/docs/sequenceDiagram.md
View File

@ -364,7 +364,7 @@ It is possible to get a sequence number attached to each arrow in a sequence dia
```html ```html
<script> <script>
mermaid.initialize({ sequence: { showSequenceNumbers: true } }); mermaid.initialize({ sequence: { showSequenceNumbers: true } });
</script> </script>
``` ```
@ -454,81 +454,81 @@ Styling of a sequence diagram is done by defining a number of css classes. Durin
```css ```css
body { body {
background: white; background: white;
} }
.actor { .actor {
stroke: #ccccff; stroke: #ccccff;
fill: #ececff; fill: #ececff;
} }
text.actor { text.actor {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: Helvetica; font-family: Helvetica;
} }
.actor-line { .actor-line {
stroke: grey; stroke: grey;
} }
.messageLine0 { .messageLine0 {
stroke-width: 1.5; stroke-width: 1.5;
stroke-dasharray: '2 2'; stroke-dasharray: '2 2';
marker-end: 'url(#arrowhead)'; marker-end: 'url(#arrowhead)';
stroke: black; stroke: black;
} }
.messageLine1 { .messageLine1 {
stroke-width: 1.5; stroke-width: 1.5;
stroke-dasharray: '2 2'; stroke-dasharray: '2 2';
stroke: black; stroke: black;
} }
#arrowhead { #arrowhead {
fill: black; fill: black;
} }
.messageText { .messageText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
font-size: 14px; font-size: 14px;
} }
.labelBox { .labelBox {
stroke: #ccccff; stroke: #ccccff;
fill: #ececff; fill: #ececff;
} }
.labelText { .labelText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
} }
.loopText { .loopText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
} }
.loopLine { .loopLine {
stroke-width: 2; stroke-width: 2;
stroke-dasharray: '2 2'; stroke-dasharray: '2 2';
marker-end: 'url(#arrowhead)'; marker-end: 'url(#arrowhead)';
stroke: #ccccff; stroke: #ccccff;
} }
.note { .note {
stroke: #decc93; stroke: #decc93;
fill: #fff5ad; fill: #fff5ad;
} }
.noteText { .noteText {
fill: black; fill: black;
stroke: none; stroke: none;
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
font-size: 14px; font-size: 14px;
} }
``` ```
@ -542,12 +542,12 @@ How to use the CLI is described in the [mermaidCLI](mermaidCLI) page.
```javascript ```javascript
mermaid.sequenceConfig = { mermaid.sequenceConfig = {
diagramMarginX: 50, diagramMarginX: 50,
diagramMarginY: 10, diagramMarginY: 10,
boxTextMargin: 5, boxTextMargin: 5,
noteMargin: 10, noteMargin: 10,
messageMargin: 35, messageMargin: 35,
mirrorActors: true, mirrorActors: true,
}; };
``` ```

11
src/docs/stateDiagram.md
View File

@ -140,7 +140,7 @@ stateDiagram-v2
} }
``` ```
*You can not define transitions between internal states belonging to different composite states* _You can not define transitions between internal states belonging to different composite states_
## Choice ## Choice
@ -177,7 +177,7 @@ It is possible to specify a fork in the diagram using &lt;&lt;fork&gt;&gt; &lt;&
Sometimes nothing says it better then a Post-it note. That is also the case in state diagrams. Sometimes nothing says it better then a Post-it note. That is also the case in state diagrams.
Here you can choose to put the note to the *right of* or to the *left of* a node. Here you can choose to put the note to the _right of_ or to the _left of_ a node.
```mermaid-example ```mermaid-example
stateDiagram-v2 stateDiagram-v2
@ -228,12 +228,11 @@ stateDiagram
a --> b a --> b
} }
B --> D B --> D
``` ```
## Comments ## Comments
Comments can be entered within a state diagram chart, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any diagram syntax Comments can be entered within a state diagram chart, which will be ignored by the parser. Comments need to be on their own line, and must be prefaced with `%%` (double percent signs). Any text after the start of the comment to the next newline will be treated as a comment, including any diagram syntax
```mmd ```mmd
stateDiagram-v2 stateDiagram-v2
@ -248,7 +247,7 @@ stateDiagram-v2
## Styling ## Styling
Styling of the a state diagram is done by defining a number of css classes. During rendering these classes are extracted from the file located at src/themes/state.scss Styling of the a state diagram is done by defining a number of css classes. During rendering these classes are extracted from the file located at src/themes/state.scss
## Spaces in state names ## Spaces in state names

828
src/docs/theme.css
View File

File diff suppressed because one or more lines are too long

1653
src/docs/theme_themed.css
View File

File diff suppressed because one or more lines are too long

10
src/docs/theming.md
View File

@ -28,8 +28,8 @@ Example of `Initialize` call setting `theme` to `base`:
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
securityLevel: 'loose', securityLevel: 'loose',
theme: 'base', theme: 'base',
}); });
``` ```
@ -220,9 +220,9 @@ Variables that are unique to some diagrams can be affected by changes in Theme V
\*\*This got a bit too dark and bit too colorful. With some easy steps this can be fixed: \*\*This got a bit too dark and bit too colorful. With some easy steps this can be fixed:
- Make the primary color a little lighter - Make the primary color a little lighter
- set the tertiary color to a reddish shade as well - set the tertiary color to a reddish shade as well
- make the edge label background differ from the subgraph by setting the edgeLabelBackground - make the edge label background differ from the subgraph by setting the edgeLabelBackground
```mermaid-example ```mermaid-example
%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%% %%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%%

11
src/docs/upgrading.md
View File

@ -2,27 +2,24 @@
Some of the interfaces has been upgraded. Some of the interfaces has been upgraded.
## From version 0.4.0 to 0.5.0 ## From version 0.4.0 to 0.5.0
### Initialization ### Initialization
`mermaid_config` is no longer used. Instead a call to mermaid initialize is done as in the example below: `mermaid_config` is no longer used. Instead a call to mermaid initialize is done as in the example below:
#### version 0.4.0 #### version 0.4.0
```javascript ```javascript
mermaid_config = { mermaid_config = {
startOnLoad: true startOnLoad: true,
} };
``` ```
#### version 0.5.0 #### version 0.5.0
```javascript ```javascript
mermaid.initialize({ mermaid.initialize({
startOnLoad: true startOnLoad: true,
}) });
``` ```

134
src/docs/usage.md
View File

@ -43,22 +43,22 @@ The easiest way to integrate mermaid on a web page requires three elements:
1. Inclusion of the mermaid address in the html page using a `script` tag, in the `src` section.Example: 1. Inclusion of the mermaid address in the html page using a `script` tag, in the `src` section.Example:
```html ```html
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
``` ```
2. The `mermaidAPI` call, in a separate `script` tag. Example: 2. The `mermaidAPI` call, in a separate `script` tag. Example:
```html ```html
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
``` ```
3. A graph definition, inside `<div>` tags labeled `class=mermaid`. Example: 3. A graph definition, inside `<div>` tags labeled `class=mermaid`. Example:
```html ```html
<div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div> <div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div>
``` ```
**Following these directions, mermaid starts at page load and (when the page has loaded) it will **Following these directions, mermaid starts at page load and (when the page has loaded) it will
locate the graph definitions inside the `div` tags with `class="mermaid"` and return diagrams in SVG form, following given definitions.** locate the graph definitions inside the `div` tags with `class="mermaid"` and return diagrams in SVG form, following given definitions.**
@ -68,16 +68,16 @@ locate the graph definitions inside the `div` tags with `class="mermaid"` and re
```html ```html
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<head> <head>
<meta charset="utf-8" /> <meta charset="utf-8" />
</head> </head>
<body> <body>
<div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div> <div class="mermaid">graph LR A --- B B-->C[fa:fa-ban forbidden] B-->D(fa:fa-spinner);</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script> <script>
mermaid.initialize({ startOnLoad: true }); mermaid.initialize({ startOnLoad: true });
</script> </script>
</body> </body>
</html> </html>
``` ```
@ -103,10 +103,10 @@ A `securityLevel` configuration has to first be cleared, `securityLevel` sets th
Values: Values:
- **strict**: (**default**) tags in text are encoded, click functionality is disabled - **strict**: (**default**) tags in text are encoded, click functionality is disabled
- **loose**: tags in text are allowed, click functionality is enabled - **loose**: tags in text are allowed, click functionality is enabled
- **antiscript**: html tags in text are allowed, (only script element is removed), click functionality is enabled - **antiscript**: html tags in text are allowed, (only script element is removed), click functionality is enabled
- **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This prevent any JavaScript running in the context. This may hinder interactive functionality of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. - **sandbox**: With this security level all rendering takes place in a sandboxed iframe. This prevent any JavaScript running in the context. This may hinder interactive functionality of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc.
```note ```note
This changes the default behaviour of mermaid so that after upgrade to 8.2, unless the `securityLevel` is not changed, tags in flowcharts are encoded as tags and clicking is disabled. This changes the default behaviour of mermaid so that after upgrade to 8.2, unless the `securityLevel` is not changed, tags in flowcharts are encoded as tags and clicking is disabled.
@ -119,7 +119,7 @@ This changes the default behaviour of mermaid so that after upgrade to 8.2, unle
```javascript ```javascript
mermaidAPI.initialize({ mermaidAPI.initialize({
securityLevel: 'loose', securityLevel: 'loose',
}); });
``` ```
@ -130,7 +130,7 @@ whole page to load (dom + assets, particularly the fonts file).
```javascript ```javascript
$(document).load(function () { $(document).load(function () {
mermaid.initialize(); mermaid.initialize();
}); });
``` ```
@ -138,7 +138,7 @@ or
```javascript ```javascript
$(document).ready(function () { $(document).ready(function () {
mermaid.initialize(); mermaid.initialize();
}); });
``` ```
@ -148,7 +148,7 @@ If your page has other fonts in its body those might be used instead of the merm
```css ```css
div.mermaid { div.mermaid {
font-family: 'trebuchet ms', verdana, arial; font-family: 'trebuchet ms', verdana, arial;
} }
``` ```
@ -158,11 +158,11 @@ By default, `mermaid.init` will be called when the document is ready, finding al
`class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need `class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need
finer-grained control of this behavior, you can call `init` yourself with: finer-grained control of this behavior, you can call `init` yourself with:
- a configuration object - a configuration object
- some nodes, as - some nodes, as
- a node - a node
- an array-like of nodes - an array-like of nodes
- or W3C selector that will find your nodes - or W3C selector that will find your nodes
Example: Example:
@ -196,16 +196,16 @@ The example below show an outline of how this could be used. The example just lo
<script src="mermaid.js"></script> <script src="mermaid.js"></script>
<script> <script>
mermaid.mermaidAPI.initialize({ startOnLoad: false }); mermaid.mermaidAPI.initialize({ startOnLoad: false });
$(function () { $(function () {
// Example of using the API var // Example of using the API var
element = document.querySelector('#graphDiv'); element = document.querySelector('#graphDiv');
var insertSvg = function (svgCode, bindFunctions) { var insertSvg = function (svgCode, bindFunctions) {
element.innerHTML = svgCode; element.innerHTML = svgCode;
}; };
var graphDefinition = 'graph TB\na-->b'; var graphDefinition = 'graph TB\na-->b';
var graph = mermaid.mermaidAPI.render('graphDiv', graphDefinition, insertSvg); var graph = mermaid.mermaidAPI.render('graphDiv', graphDefinition, insertSvg);
}); });
</script> </script>
``` ```
@ -219,11 +219,11 @@ bind events to an SVG when using the API for rendering.
```javascript ```javascript
var insertSvg = function (svgCode, bindFunctions) { var insertSvg = function (svgCode, bindFunctions) {
element.innerHTML = svgCode; element.innerHTML = svgCode;
if (typeof callback !== 'undefined') { if (typeof callback !== 'undefined') {
callback(id); callback(id);
} }
bindFunctions(element); bindFunctions(element);
}; };
var id = 'theGraph'; var id = 'theGraph';
@ -244,11 +244,11 @@ This is the renderer used for transforming the documentation from Markdown to ht
```javascript ```javascript
var renderer = new marked.Renderer(); var renderer = new marked.Renderer();
renderer.code = function (code, language) { renderer.code = function (code, language) {
if (code.match(/^sequenceDiagram/) || code.match(/^graph/)) { if (code.match(/^sequenceDiagram/) || code.match(/^graph/)) {
return '<div class="mermaid">' + code + '</div>'; return '<div class="mermaid">' + code + '</div>';
} else { } else {
return '<pre><code>' + code + '</code></pre>'; return '<pre><code>' + code + '</code></pre>';
} }
}; };
``` ```
@ -290,15 +290,15 @@ The code-example below in meta code illustrates how this could work:
```javascript ```javascript
mermaid.parseError = function (err, hash) { mermaid.parseError = function (err, hash) {
displayErrorInGui(err); displayErrorInGui(err);
}; };
var textFieldUpdated = function () { var textFieldUpdated = function () {
var textStr = getTextFromFormField('code'); var textStr = getTextFromFormField('code');
if (mermaid.parse(textStr)) { if (mermaid.parse(textStr)) {
reRender(textStr); reRender(textStr);
} }
}; };
bindEventHandler('change', 'code', textFieldUpdated); bindEventHandler('change', 'code', textFieldUpdated);
@ -328,8 +328,8 @@ on what kind of integration you use.
```html ```html
<script src="../dist/mermaid.js"></script> <script src="../dist/mermaid.js"></script>
<script> <script>
var config = { startOnLoad: true, flowchart: { useMaxWidth: false, htmlLabels: true } }; var config = { startOnLoad: true, flowchart: { useMaxWidth: false, htmlLabels: true } };
mermaid.initialize(config); mermaid.initialize(config);
</script> </script>
``` ```
@ -344,8 +344,8 @@ This is the preferred way of configuring mermaid.
Is it possible to set some configuration via the mermaid object. The two parameters that are supported using this Is it possible to set some configuration via the mermaid object. The two parameters that are supported using this
approach are: approach are:
- mermaid.startOnLoad - mermaid.startOnLoad
- mermaid.htmlLabels - mermaid.htmlLabels
```javascript ```javascript
mermaid.startOnLoad = true; mermaid.startOnLoad = true;
@ -360,8 +360,8 @@ This way of setting the configuration is deprecated. Instead the preferred way i
It is possible to set some configuration via the mermaid object. The two parameters that are supported using this It is possible to set some configuration via the mermaid object. The two parameters that are supported using this
approach are: approach are:
- mermaid_config.startOnLoad - mermaid_config.startOnLoad
- mermaid_config.htmlLabels - mermaid_config.htmlLabels
```javascript ```javascript
mermaid_config.startOnLoad = true; mermaid_config.startOnLoad = true;
@ -375,8 +375,8 @@ This way of setting the configuration is deprecated. Instead the preferred way i
To set some configuration via the mermaid object. The two parameters that are supported using this approach are: To set some configuration via the mermaid object. The two parameters that are supported using this approach are:
- mermaid_config.startOnLoad - mermaid_config.startOnLoad
- mermaid_config.htmlLabels - mermaid_config.htmlLabels
```javascript ```javascript
mermaid_config.startOnLoad = true; mermaid_config.startOnLoad = true;

3
test.js
View File

@ -1,3 +1,6 @@
/**
*
*/
function apa() { function apa() {
// comment's // comment's
const a = 1; const a = 1;