diff --git a/.eslintrc.json b/.eslintrc.json index 1dfdf65cd..1c84491dc 100644 --- a/.eslintrc.json +++ b/.eslintrc.json @@ -18,9 +18,9 @@ "plugin:jsdoc/recommended", "plugin:json/recommended", "plugin:markdown/recommended", - "plugin:prettier/recommended" + "prettier" ], - "plugins": ["html", "jest", "jsdoc", "json", "prettier"], + "plugins": ["html", "jest", "jsdoc", "json"], "rules": { "no-prototype-builtins": "off", "no-unused-vars": "off", @@ -45,12 +45,6 @@ "no-undef": "off", "jsdoc/require-jsdoc": "off" } - }, - { - "files": "./**/*.md/*.html", - "rules": { - "prettier/prettier": "off" - } } ] } diff --git a/.lintstagedrc.json b/.lintstagedrc.json index 32fa68227..accda3529 100644 --- a/.lintstagedrc.json +++ b/.lintstagedrc.json @@ -1,8 +1,4 @@ { - "src/docs/**": [ - "yarn docs:build" - ], - "*.{js,json,html,md}": [ - "yarn lint:fix" - ] -} \ No newline at end of file + "src/docs/**": ["yarn docs:build"], + "*.{js,json,html,md}": ["yarn lint:fix"] +} diff --git a/.prettierignore b/.prettierignore index 71d07c514..5a76e6faf 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,3 @@ -demos/*.html \ No newline at end of file +demos/*.html +cypress/**/*.html +dist \ No newline at end of file diff --git a/.prettierrc.json b/.prettierrc.json index 0835748d6..94e235941 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -2,4 +2,4 @@ "endOfLine": "auto", "printWidth": 100, "singleQuote": true -} \ No newline at end of file +} diff --git a/docs/8.6.0_docs.md b/docs/8.6.0_docs.md index 3d4a19895..b532a1c94 100644 --- a/docs/8.6.0_docs.md +++ b/docs/8.6.0_docs.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Version 8.6.0 Changes ## [New Mermaid Live-Editor Beta](https://mermaid-js.github.io/docs/mermaid-live-editor-beta/#/edit/eyJjb2RlIjoiJSV7aW5pdDoge1widGhlbWVcIjogXCJmb3Jlc3RcIiwgXCJsb2dMZXZlbFwiOiAxIH19JSVcbmdyYXBoIFREXG4gIEFbQ2hyaXN0bWFzXSAtLT58R2V0IG1vbmV5fCBCKEdvIHNob3BwaW5nKVxuICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgQyAtLT58T25lfCBEW0xhcHRvcF1cbiAgQyAtLT58VHdvfCBFW2lQaG9uZV1cbiAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl1cblx0XHQiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGFyayJ9fQ) @@ -16,19 +17,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. -| Level of Configuration | Description | -| --- | --- | -| Global Configuration| Default Mermaid Configurations| -| Site Configuration| Configurations made by site owner| -| Current Configuration| Configurations made by Implementors| +| Level of Configuration | Description | +| ---------------------- | ----------------------------------- | +| Global Configuration | Default Mermaid Configurations | +| Site Configuration | Configurations made by site owner | +| Current Configuration | Configurations made by Implementors | # Limits to Modifying Configurations **secure Array** -| Parameter | Description |Type | Required | Values| -| --- | --- | --- | --- | --- | -| secure | Array of parameters excluded from init directive| Array | Required | Any parameters| +| Parameter | Description | Type | Required | Values | +| --------- | ------------------------------------------------ | ----- | -------- | -------------- | +| 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. @@ -57,9 +58,9 @@ Older versions of mermaid will not parse directives because `%%` will comment ou `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| -| --- | --- | --- | --- | --- | -| init | modifies configurations| Directive| Optional | Any parameters not included in the secure array| +| Parameter | Description | Type | Required | Values | +| --------- | ----------------------- | --------- | -------- | ----------------------------------------------- | +| init | modifies configurations | Directive | Optional | Any parameters not included in the secure array | ```note init would be an argument-directive: `%%{init: { **insert argument here**}}%%` @@ -90,9 +91,9 @@ When deployed within code, init is called before the graph/diagram description. # Wrap -| Parameter | Description |Type | Required | Values| -| --- | --- | --- | --- | --- | -| wrap | a callable text-wrap function| Directive| Optional | %%{wrap}%%| +| Parameter | Description | Type | Required | Values | +| --------- | ----------------------------- | --------- | -------- | ---------- | +| wrap | a callable text-wrap function | Directive | Optional | %%{wrap}%% | ```note Wrap is a function that is currently only deployable for sequence diagrams. @@ -120,9 +121,9 @@ There are two more functions in the mermaidAPI that can be called by site owners # Additional Utils to mermaid -• **memoize**: simple caching for computationally expensive functions, reducing rendering time by about 90%. +• **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. +• **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**: @@ -132,7 +133,7 @@ Example of **object.Assign**: ![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. @@ -140,9 +141,9 @@ Example of **object.Assign**: ## setSiteConfig -| Function | Description | Type | Values |Parameters|Returns| -| --------- | ------------------- | ------- | ------------------ | ------------------ | ------------------ | -| `setSiteConfig`|Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array|conf|siteConfig| +| Function | Description | Type | Values | Parameters | Returns | +| --------------- | ------------------------------------- | ----------- | --------------------------------------- | ---------- | ---------- | +| `setSiteConfig` | Sets the siteConfig to desired values | Put Request | Any Values, except ones in secure array | conf | siteConfig | ```note Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset @@ -154,9 +155,9 @@ Default value: will mirror Global Config ## getSiteConfig -| Function | Description | Type | Values | -| --------- | ------------------- | ------- | ------------------ | -| `getSiteConfig`|Returns the current `siteConfig` base configuration | Get Request | Returns Any Values in `siteConfig`| +| Function | Description | Type | Values | +| --------------- | --------------------------------------------------- | ----------- | ---------------------------------- | +| `getSiteConfig` | Returns the current `siteConfig` base configuration | Get Request | Returns Any Values in `siteConfig` | ```note Returns any values in siteConfig. @@ -164,9 +165,9 @@ Returns any values in siteConfig. ## setConfig -| 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| +| 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 | ```note Sets the currentConfig. The parameter conf is sanitized based on the siteConfig.secure keys. Any @@ -176,9 +177,9 @@ siteConfig value. ## getConfig -| Function | Description | Type | Return Values | -| --------- | ------------------- | ------- | ------------------ | -| `getConfig` |Obtains the `currentConfig` | Get Request | Any Values from `currentConfig`| +| Function | Description | Type | Return Values | +| ----------- | --------------------------- | ----------- | ------------------------------- | +| `getConfig` | Obtains the `currentConfig` | Get Request | Any Values from `currentConfig` | ```note Returns any values in currentConfig. @@ -186,9 +187,9 @@ Returns any values in currentConfig. ## sanitize -| Function | Description | Type | Values | -| --------- | ------------------- | ------- | ------------------ | -| `sanitize` |Sets the `siteConfig` to desired values. | Put Request(?) |None| +| Function | Description | Type | Values | +| ---------- | ---------------------------------------- | -------------- | ------ | +| `sanitize` | Sets the `siteConfig` to desired values. | Put Request(?) | None | ```note modifies options in-place @@ -197,15 +198,15 @@ Ensures options parameter does not attempt to override siteConfig secure keys. ## reset -| Function | Description | Type | Required | Values |Parameter| -| --------- | -------------------| ------- | -------- | ------------------ |---------| -| `reset`|Resets `currentConfig` to conf| Put Request | Required | None| conf| +| Function | Description | Type | Required | Values | Parameter | +| -------- | ------------------------------ | ----------- | -------- | ------ | --------- | +| `reset` | Resets `currentConfig` to conf | Put Request | Required | None | conf | ## conf -| 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| +| 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 | ```note default: current siteConfig (optional, default `getSiteConfig()`) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index fa9028c36..7638bc0cf 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Change Log All changes are in descending order, beginning with the newest (latest) version. @@ -27,7 +28,8 @@ Example of `Initalize` call setting `theme` to `base`: ```javascript mermaidAPI.initialize({ - 'securityLevel': 'loose', 'theme': 'base' + securityLevel: 'loose', + theme: 'base', }); ``` @@ -50,7 +52,7 @@ 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%%`. -| 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 | @@ -117,9 +119,9 @@ This was introduced in version 8.2 as a security improvement, aimed at preventin **Notes:** -* **strict**: (**default**) tags in text are encoded, click functionality is disabled -* **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 +- **strict**: (**default**) tags in text are encoded, click functionality is disabled +- **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 ⚠️ **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,15 +131,15 @@ By doing this clicks and tags are again allowed. ### To change `securityLevel` with `mermaidAPI.initialize`: ```javascript - mermaidAPI.initialize({ - securityLevel: 'loose' - }); +mermaidAPI.initialize({ + securityLevel: 'loose', +}); ``` **Closed issues:** -* please add tag for 8.0.0 release [#863](https://github.com/knsv/mermaid/issues/863) -* classDiagram breaks on any edit [#858](https://github.com/knsv/mermaid/issues/858) +- please add tag for 8.0.0 release [#863](https://github.com/knsv/mermaid/issues/863) +- classDiagram breaks on any edit [#858](https://github.com/knsv/mermaid/issues/858) ## [8.1.0](https://github.com/knsv/mermaid/tree/8.1.0) (2019-06-25) @@ -145,212 +147,212 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Theme for dark background [#301](https://github.com/knsv/mermaid/issues/301) -* \[Feature request] gantt diagram axis format [#269](https://github.com/knsv/mermaid/issues/269) -* Implement render function for server side rendering using phantomjs [#169](https://github.com/knsv/mermaid/issues/169) +- Theme for dark background [#301](https://github.com/knsv/mermaid/issues/301) +- \[Feature request] gantt diagram axis format [#269](https://github.com/knsv/mermaid/issues/269) +- Implement render function for server side rendering using phantomjs [#169](https://github.com/knsv/mermaid/issues/169) **Fixed bugs:** -* mermaid -v filename.mmd gives You must specify at least one source file. [#328](https://github.com/knsv/mermaid/issues/328) -* Not Able to See Labels even htmlLabels:false added [#268](https://github.com/knsv/mermaid/issues/268) +- mermaid -v filename.mmd gives You must specify at least one source file. [#328](https://github.com/knsv/mermaid/issues/328) +- Not Able to See Labels even htmlLabels:false added [#268](https://github.com/knsv/mermaid/issues/268) **Closed issues:** -* Gantt and sequence diagram do not render [#853](https://github.com/knsv/mermaid/issues/853) -* margins around flowchart are not balanced [#852](https://github.com/knsv/mermaid/issues/852) -* Smaller bundles [#843](https://github.com/knsv/mermaid/issues/843) -* 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) -* 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) -* 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) -* Multi-platform CI [#744](https://github.com/knsv/mermaid/issues/744) -* gantt: sections can't have a colon [#742](https://github.com/knsv/mermaid/issues/742) -* Yarn build does not add mermaid.min.css to dist [#732](https://github.com/knsv/mermaid/issues/732) -* Is there a grammar / keyword / more than just the basic examples? [#718](https://github.com/knsv/mermaid/issues/718) -* Click event and react component [#717](https://github.com/knsv/mermaid/issues/717) -* Long text going outside the box [#706](https://github.com/knsv/mermaid/issues/706) -* How to migrate from yUML to mermaid? [#704](https://github.com/knsv/mermaid/issues/704) -* 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) -* 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) -* 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) -* "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) -* 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) -* 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) -* 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) -* 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) -* 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) -* Gantt sections are not separated by colors - Fix: set numberSectionStyles to 4 instead of 3 [#620](https://github.com/knsv/mermaid/issues/620) -* how to get mermaidAPI? [#617](https://github.com/knsv/mermaid/issues/617) -* Error in startOnLoad documentation? [#616](https://github.com/knsv/mermaid/issues/616) -* Example export to SVG generates error [#614](https://github.com/knsv/mermaid/issues/614) -* The new online editor does not support previously generated links [#613](https://github.com/knsv/mermaid/issues/613) -* Grammar / Syntax documentation for flowcharts [#607](https://github.com/knsv/mermaid/issues/607) -* Mermaid does not work with d3.js [#606](https://github.com/knsv/mermaid/issues/606) -* Why does this code's flowchart lines get cut-off on screen? [#604](https://github.com/knsv/mermaid/issues/604) -* click keyword does not fire my callback (on the demo Website too) [#603](https://github.com/knsv/mermaid/issues/603) -* Online Editor fails to show exported SVG [#601](https://github.com/knsv/mermaid/issues/601) -* Just saying thanks! [#597](https://github.com/knsv/mermaid/issues/597) -* stylesheet crashed with other library like abcjs [#596](https://github.com/knsv/mermaid/issues/596) -* Missing connection [#594](https://github.com/knsv/mermaid/issues/594) -* How to use mermaid on node.js restful api? [#593](https://github.com/knsv/mermaid/issues/593) -* Remove status code [#589](https://github.com/knsv/mermaid/issues/589) -* Golang based editor [#588](https://github.com/knsv/mermaid/issues/588) -* sequenceDiagram -> notetext css font is hardcoded [#587](https://github.com/knsv/mermaid/issues/587) -* Multiple graph in the live editor [#586](https://github.com/knsv/mermaid/issues/586) -* All \ elements in page are colored black [#584](https://github.com/knsv/mermaid/issues/584) -* Styling: classes aren't applied to elements. [#582](https://github.com/knsv/mermaid/issues/582) -* Rounded connections [#580](https://github.com/knsv/mermaid/issues/580) -* Arrows are not being shown correctly in the dark theme [#578](https://github.com/knsv/mermaid/issues/578) -* The documentation for CLI seems outdated. [#572](https://github.com/knsv/mermaid/issues/572) -* No effect of click event:can not open link [#571](https://github.com/knsv/mermaid/issues/571) -* Text colors are not correct in VSCODE [#570](https://github.com/knsv/mermaid/issues/570) -* Nodes aren't aligned properly (just need an explanation) [#568](https://github.com/knsv/mermaid/issues/568) -* setting margin around figure in R [#567](https://github.com/knsv/mermaid/issues/567) -* Arrows should Come out in upward and Downward direction from decision Node [#566](https://github.com/knsv/mermaid/issues/566) -* 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) -* 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) -* 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) -* Arrow heads missing (cli, 7.0.3) [#544](https://github.com/knsv/mermaid/issues/544) -* No Edge Boxes if useHtmlLabels=false [#541](https://github.com/knsv/mermaid/issues/541) -* how to change mermaid text color or line text block color? [#534](https://github.com/knsv/mermaid/issues/534) -* FlowChart visualization broken when downloading from live editor [#533](https://github.com/knsv/mermaid/issues/533) -* Can't get flowchart to render paths at the top of the diagram; I even tried the online editor and that shows the same issue. Thoughts? [#532](https://github.com/knsv/mermaid/issues/532) -* live editor make browser(safari on macOS\&iOS) not longer respond [#531](https://github.com/knsv/mermaid/issues/531) -* css classes need a prefix/namespace [#527](https://github.com/knsv/mermaid/issues/527) -* input activate/deactivate cause safari unresponding [#521](https://github.com/knsv/mermaid/issues/521) -* Cannot Render the Mermaid Graph to PDF ? [#520](https://github.com/knsv/mermaid/issues/520) -* clicking links works from inset in subgraph but not from nodes [#516](https://github.com/knsv/mermaid/issues/516) -* Strange syntax error - when importing mermaid.js [#515](https://github.com/knsv/mermaid/issues/515) -* gantt x-axis display [#510](https://github.com/knsv/mermaid/issues/510) -* phantomjs renamed to phantomjs-prebuilt [#508](https://github.com/knsv/mermaid/issues/508) -* issue when using sphinxcontrib-mermaid extension for sphinx [#507](https://github.com/knsv/mermaid/issues/507) -* layout of docs page looks broken [#504](https://github.com/knsv/mermaid/issues/504) -* Problem showing graph with php on localhost [#502](https://github.com/knsv/mermaid/issues/502) -* logLevel's option doesn't work at 7.0.0 [#501](https://github.com/knsv/mermaid/issues/501) -* How do I get the log for a render or parse attempt? [#500](https://github.com/knsv/mermaid/issues/500) -* Mermaid neutral style style to built in latest release [#499](https://github.com/knsv/mermaid/issues/499) -* Any plans for adding a typescript definition file? [#495](https://github.com/knsv/mermaid/issues/495) -* Gantt diagrams too narrow [#493](https://github.com/knsv/mermaid/issues/493) -* 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) -* 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) -* 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) -* Mermaid resets some of the page CSS styles [#482](https://github.com/knsv/mermaid/issues/482) -* Arrows rendering incorrectly in online editor [#480](https://github.com/knsv/mermaid/issues/480) -* CSS stroke-dasharray ignored by browsers but not other viewers [#474](https://github.com/knsv/mermaid/issues/474) -* mermaid - Browser Support issue [#472](https://github.com/knsv/mermaid/issues/472) -* Totally love mermaid I might pop! [#471](https://github.com/knsv/mermaid/issues/471) -* Sequence Diagram: Missing x on async arrows (png) [#469](https://github.com/knsv/mermaid/issues/469) -* live editor: the svg file rendered from graph is not supported by browsers [#468](https://github.com/knsv/mermaid/issues/468) -* Not found css [#462](https://github.com/knsv/mermaid/issues/462) -* Phantomjs Dependency [#461](https://github.com/knsv/mermaid/issues/461) -* Mermaid cli not working for subgraphs [#459](https://github.com/knsv/mermaid/issues/459) -* Support for notes across multiple participants? [#458](https://github.com/knsv/mermaid/issues/458) -* Related to Issue #329: Phantomjs issues. [#455](https://github.com/knsv/mermaid/issues/455) -* Add a click style [#426](https://github.com/knsv/mermaid/issues/426) -* Add Parallel block (par) to sequence diagrams [#425](https://github.com/knsv/mermaid/issues/425) -* updating shapes after the flow chart rendering complete [#424](https://github.com/knsv/mermaid/issues/424) -* can't catch parse error Maximum call stack size exceeded on safari [#421](https://github.com/knsv/mermaid/issues/421) -* Arrows endings are missing [#419](https://github.com/knsv/mermaid/issues/419) -* 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) -* 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: 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) -* Cannot center-justify text in nodes? [#397](https://github.com/knsv/mermaid/issues/397) -* Edge labels should have white background in live editor [#396](https://github.com/knsv/mermaid/issues/396) -* Live editor does not support activate/deactivate [#394](https://github.com/knsv/mermaid/issues/394) -* Styling subgraph? [#391](https://github.com/knsv/mermaid/issues/391) -* Update live editor to version 6.0.0 [#387](https://github.com/knsv/mermaid/issues/387) -* 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) -* 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) -* 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) -* when declaring participants the elements are generated twice [#370](https://github.com/knsv/mermaid/issues/370) -* Example Flowchart is cut in display (Chrome). [#368](https://github.com/knsv/mermaid/issues/368) -* Add shebang support to diagrams [#365](https://github.com/knsv/mermaid/issues/365) -* Silencing CLI output [#352](https://github.com/knsv/mermaid/issues/352) -* SequenceDiagram: 3+ Alternative Paths [#348](https://github.com/knsv/mermaid/issues/348) -* Smaller height of actor boxes [#342](https://github.com/knsv/mermaid/issues/342) -* Question: lib/phantomscript.js - foreignObjects in SVG - related to #58 [#340](https://github.com/knsv/mermaid/issues/340) -* npm test fails on osx being blocked at Can not load "PhantomJS", it is not registered! [#337](https://github.com/knsv/mermaid/issues/337) -* Tabs & subgraphs cause rendering error [#336](https://github.com/knsv/mermaid/issues/336) -* Display question: right angles [#335](https://github.com/knsv/mermaid/issues/335) -* No Arrows rendered v0.5.8 [#330](https://github.com/knsv/mermaid/issues/330) -* You had errors in your syntax. Use --help for further information. [#327](https://github.com/knsv/mermaid/issues/327) -* Allow alternate arrow syntax that doesn't close html comments [#322](https://github.com/knsv/mermaid/issues/322) -* Comment in subgraph [#319](https://github.com/knsv/mermaid/issues/319) -* Update graph [#311](https://github.com/knsv/mermaid/issues/311) -* css conflicts with boostrap's css [#308](https://github.com/knsv/mermaid/issues/308) -* Can not get click event to fire. [#306](https://github.com/knsv/mermaid/issues/306) -* Fix phantomjs2 compatibility [#304](https://github.com/knsv/mermaid/issues/304) -* Flowcharts do not work in native IE11 [#303](https://github.com/knsv/mermaid/issues/303) -* Integration with remark.js - tutorial added [#302](https://github.com/knsv/mermaid/issues/302) -* Sequence diagram Loops: changing boxMargin spoils the "loop" notation [#299](https://github.com/knsv/mermaid/issues/299) -* src/mermaid.js generates bad code [#297](https://github.com/knsv/mermaid/issues/297) -* Fresh fork: jasmine tests fail [#294](https://github.com/knsv/mermaid/issues/294) -* CSS clash [#292](https://github.com/knsv/mermaid/issues/292) -* 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) -* 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) -* IE11 Support issue [#261](https://github.com/knsv/mermaid/issues/261) -* mermaid without browser [#260](https://github.com/knsv/mermaid/issues/260) -* Insufficient capacity of gantt diagrams [#226](https://github.com/knsv/mermaid/issues/226) -* some WARN about installation [#222](https://github.com/knsv/mermaid/issues/222) -* Live editor offline access [#217](https://github.com/knsv/mermaid/issues/217) -* suggest: code highlight mode config for editors [#212](https://github.com/knsv/mermaid/issues/212) -* Uncaught RangeError: Maximum call stack size exceeded [#189](https://github.com/knsv/mermaid/issues/189) -* Styling label texts [#50](https://github.com/knsv/mermaid/issues/50) +- Gantt and sequence diagram do not render [#853](https://github.com/knsv/mermaid/issues/853) +- margins around flowchart are not balanced [#852](https://github.com/knsv/mermaid/issues/852) +- Smaller bundles [#843](https://github.com/knsv/mermaid/issues/843) +- 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) +- 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) +- 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) +- Multi-platform CI [#744](https://github.com/knsv/mermaid/issues/744) +- gantt: sections can't have a colon [#742](https://github.com/knsv/mermaid/issues/742) +- Yarn build does not add mermaid.min.css to dist [#732](https://github.com/knsv/mermaid/issues/732) +- Is there a grammar / keyword / more than just the basic examples? [#718](https://github.com/knsv/mermaid/issues/718) +- Click event and react component [#717](https://github.com/knsv/mermaid/issues/717) +- Long text going outside the box [#706](https://github.com/knsv/mermaid/issues/706) +- How to migrate from yUML to mermaid? [#704](https://github.com/knsv/mermaid/issues/704) +- 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) +- 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) +- 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) +- "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) +- 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) +- 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) +- 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) +- 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) +- 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) +- Gantt sections are not separated by colors - Fix: set numberSectionStyles to 4 instead of 3 [#620](https://github.com/knsv/mermaid/issues/620) +- how to get mermaidAPI? [#617](https://github.com/knsv/mermaid/issues/617) +- Error in startOnLoad documentation? [#616](https://github.com/knsv/mermaid/issues/616) +- Example export to SVG generates error [#614](https://github.com/knsv/mermaid/issues/614) +- The new online editor does not support previously generated links [#613](https://github.com/knsv/mermaid/issues/613) +- Grammar / Syntax documentation for flowcharts [#607](https://github.com/knsv/mermaid/issues/607) +- Mermaid does not work with d3.js [#606](https://github.com/knsv/mermaid/issues/606) +- Why does this code's flowchart lines get cut-off on screen? [#604](https://github.com/knsv/mermaid/issues/604) +- click keyword does not fire my callback (on the demo Website too) [#603](https://github.com/knsv/mermaid/issues/603) +- Online Editor fails to show exported SVG [#601](https://github.com/knsv/mermaid/issues/601) +- Just saying thanks! [#597](https://github.com/knsv/mermaid/issues/597) +- stylesheet crashed with other library like abcjs [#596](https://github.com/knsv/mermaid/issues/596) +- Missing connection [#594](https://github.com/knsv/mermaid/issues/594) +- How to use mermaid on node.js restful api? [#593](https://github.com/knsv/mermaid/issues/593) +- Remove status code [#589](https://github.com/knsv/mermaid/issues/589) +- Golang based editor [#588](https://github.com/knsv/mermaid/issues/588) +- sequenceDiagram -> notetext css font is hardcoded [#587](https://github.com/knsv/mermaid/issues/587) +- Multiple graph in the live editor [#586](https://github.com/knsv/mermaid/issues/586) +- All \ elements in page are colored black [#584](https://github.com/knsv/mermaid/issues/584) +- Styling: classes aren't applied to elements. [#582](https://github.com/knsv/mermaid/issues/582) +- Rounded connections [#580](https://github.com/knsv/mermaid/issues/580) +- Arrows are not being shown correctly in the dark theme [#578](https://github.com/knsv/mermaid/issues/578) +- The documentation for CLI seems outdated. [#572](https://github.com/knsv/mermaid/issues/572) +- No effect of click event:can not open link [#571](https://github.com/knsv/mermaid/issues/571) +- Text colors are not correct in VSCODE [#570](https://github.com/knsv/mermaid/issues/570) +- Nodes aren't aligned properly (just need an explanation) [#568](https://github.com/knsv/mermaid/issues/568) +- setting margin around figure in R [#567](https://github.com/knsv/mermaid/issues/567) +- Arrows should Come out in upward and Downward direction from decision Node [#566](https://github.com/knsv/mermaid/issues/566) +- 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) +- 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) +- 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) +- Arrow heads missing (cli, 7.0.3) [#544](https://github.com/knsv/mermaid/issues/544) +- No Edge Boxes if useHtmlLabels=false [#541](https://github.com/knsv/mermaid/issues/541) +- how to change mermaid text color or line text block color? [#534](https://github.com/knsv/mermaid/issues/534) +- FlowChart visualization broken when downloading from live editor [#533](https://github.com/knsv/mermaid/issues/533) +- Can't get flowchart to render paths at the top of the diagram; I even tried the online editor and that shows the same issue. Thoughts? [#532](https://github.com/knsv/mermaid/issues/532) +- live editor make browser(safari on macOS\&iOS) not longer respond [#531](https://github.com/knsv/mermaid/issues/531) +- css classes need a prefix/namespace [#527](https://github.com/knsv/mermaid/issues/527) +- input activate/deactivate cause safari unresponding [#521](https://github.com/knsv/mermaid/issues/521) +- Cannot Render the Mermaid Graph to PDF ? [#520](https://github.com/knsv/mermaid/issues/520) +- clicking links works from inset in subgraph but not from nodes [#516](https://github.com/knsv/mermaid/issues/516) +- Strange syntax error - when importing mermaid.js [#515](https://github.com/knsv/mermaid/issues/515) +- gantt x-axis display [#510](https://github.com/knsv/mermaid/issues/510) +- phantomjs renamed to phantomjs-prebuilt [#508](https://github.com/knsv/mermaid/issues/508) +- issue when using sphinxcontrib-mermaid extension for sphinx [#507](https://github.com/knsv/mermaid/issues/507) +- layout of docs page looks broken [#504](https://github.com/knsv/mermaid/issues/504) +- Problem showing graph with php on localhost [#502](https://github.com/knsv/mermaid/issues/502) +- logLevel's option doesn't work at 7.0.0 [#501](https://github.com/knsv/mermaid/issues/501) +- How do I get the log for a render or parse attempt? [#500](https://github.com/knsv/mermaid/issues/500) +- Mermaid neutral style style to built in latest release [#499](https://github.com/knsv/mermaid/issues/499) +- Any plans for adding a typescript definition file? [#495](https://github.com/knsv/mermaid/issues/495) +- Gantt diagrams too narrow [#493](https://github.com/knsv/mermaid/issues/493) +- 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) +- 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) +- 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) +- Mermaid resets some of the page CSS styles [#482](https://github.com/knsv/mermaid/issues/482) +- Arrows rendering incorrectly in online editor [#480](https://github.com/knsv/mermaid/issues/480) +- CSS stroke-dasharray ignored by browsers but not other viewers [#474](https://github.com/knsv/mermaid/issues/474) +- mermaid - Browser Support issue [#472](https://github.com/knsv/mermaid/issues/472) +- Totally love mermaid I might pop! [#471](https://github.com/knsv/mermaid/issues/471) +- Sequence Diagram: Missing x on async arrows (png) [#469](https://github.com/knsv/mermaid/issues/469) +- live editor: the svg file rendered from graph is not supported by browsers [#468](https://github.com/knsv/mermaid/issues/468) +- Not found css [#462](https://github.com/knsv/mermaid/issues/462) +- Phantomjs Dependency [#461](https://github.com/knsv/mermaid/issues/461) +- Mermaid cli not working for subgraphs [#459](https://github.com/knsv/mermaid/issues/459) +- Support for notes across multiple participants? [#458](https://github.com/knsv/mermaid/issues/458) +- Related to Issue #329: Phantomjs issues. [#455](https://github.com/knsv/mermaid/issues/455) +- Add a click style [#426](https://github.com/knsv/mermaid/issues/426) +- Add Parallel block (par) to sequence diagrams [#425](https://github.com/knsv/mermaid/issues/425) +- updating shapes after the flow chart rendering complete [#424](https://github.com/knsv/mermaid/issues/424) +- can't catch parse error Maximum call stack size exceeded on safari [#421](https://github.com/knsv/mermaid/issues/421) +- Arrows endings are missing [#419](https://github.com/knsv/mermaid/issues/419) +- 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) +- 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: 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) +- Cannot center-justify text in nodes? [#397](https://github.com/knsv/mermaid/issues/397) +- Edge labels should have white background in live editor [#396](https://github.com/knsv/mermaid/issues/396) +- Live editor does not support activate/deactivate [#394](https://github.com/knsv/mermaid/issues/394) +- Styling subgraph? [#391](https://github.com/knsv/mermaid/issues/391) +- Update live editor to version 6.0.0 [#387](https://github.com/knsv/mermaid/issues/387) +- 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) +- 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) +- 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) +- when declaring participants the elements are generated twice [#370](https://github.com/knsv/mermaid/issues/370) +- Example Flowchart is cut in display (Chrome). [#368](https://github.com/knsv/mermaid/issues/368) +- Add shebang support to diagrams [#365](https://github.com/knsv/mermaid/issues/365) +- Silencing CLI output [#352](https://github.com/knsv/mermaid/issues/352) +- SequenceDiagram: 3+ Alternative Paths [#348](https://github.com/knsv/mermaid/issues/348) +- Smaller height of actor boxes [#342](https://github.com/knsv/mermaid/issues/342) +- Question: lib/phantomscript.js - foreignObjects in SVG - related to #58 [#340](https://github.com/knsv/mermaid/issues/340) +- npm test fails on osx being blocked at Can not load "PhantomJS", it is not registered! [#337](https://github.com/knsv/mermaid/issues/337) +- Tabs & subgraphs cause rendering error [#336](https://github.com/knsv/mermaid/issues/336) +- Display question: right angles [#335](https://github.com/knsv/mermaid/issues/335) +- No Arrows rendered v0.5.8 [#330](https://github.com/knsv/mermaid/issues/330) +- You had errors in your syntax. Use --help for further information. [#327](https://github.com/knsv/mermaid/issues/327) +- Allow alternate arrow syntax that doesn't close html comments [#322](https://github.com/knsv/mermaid/issues/322) +- Comment in subgraph [#319](https://github.com/knsv/mermaid/issues/319) +- Update graph [#311](https://github.com/knsv/mermaid/issues/311) +- css conflicts with boostrap's css [#308](https://github.com/knsv/mermaid/issues/308) +- Can not get click event to fire. [#306](https://github.com/knsv/mermaid/issues/306) +- Fix phantomjs2 compatibility [#304](https://github.com/knsv/mermaid/issues/304) +- Flowcharts do not work in native IE11 [#303](https://github.com/knsv/mermaid/issues/303) +- Integration with remark.js - tutorial added [#302](https://github.com/knsv/mermaid/issues/302) +- Sequence diagram Loops: changing boxMargin spoils the "loop" notation [#299](https://github.com/knsv/mermaid/issues/299) +- src/mermaid.js generates bad code [#297](https://github.com/knsv/mermaid/issues/297) +- Fresh fork: jasmine tests fail [#294](https://github.com/knsv/mermaid/issues/294) +- CSS clash [#292](https://github.com/knsv/mermaid/issues/292) +- 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) +- 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) +- IE11 Support issue [#261](https://github.com/knsv/mermaid/issues/261) +- mermaid without browser [#260](https://github.com/knsv/mermaid/issues/260) +- Insufficient capacity of gantt diagrams [#226](https://github.com/knsv/mermaid/issues/226) +- some WARN about installation [#222](https://github.com/knsv/mermaid/issues/222) +- Live editor offline access [#217](https://github.com/knsv/mermaid/issues/217) +- suggest: code highlight mode config for editors [#212](https://github.com/knsv/mermaid/issues/212) +- Uncaught RangeError: Maximum call stack size exceeded [#189](https://github.com/knsv/mermaid/issues/189) +- Styling label texts [#50](https://github.com/knsv/mermaid/issues/50) **Merged pull requests:** -* Remove console.log in classDB. [#861](https://github.com/knsv/mermaid/pull/861) ([Arthaey](https://github.com/Arthaey)) -* Bump sshpk from 1.13.1 to 1.16.1 [#851](https://github.com/knsv/mermaid/pull/851) ([dependabot\[bot\]](https://github.com/apps/dependabot)) -* Significantly smaller bundles [#850](https://github.com/knsv/mermaid/pull/850) ([fabiospampinato](https://github.com/fabiospampinato)) -* Support styling of subgraphs [#845](https://github.com/knsv/mermaid/pull/845) ([Qix-](https://github.com/Qix-)) -* fix dark theme loop labels not visible [#837](https://github.com/knsv/mermaid/pull/837) ([jnnnnn](https://github.com/jnnnnn)) -* fix draw function can only call once [#832](https://github.com/knsv/mermaid/pull/832) ([vaniship](https://github.com/vaniship)) -* Fix dotted lines not appearing in flowcharts when HTML labels disabled [#828](https://github.com/knsv/mermaid/pull/828) ([stanhu](https://github.com/stanhu)) -* Fix issue with XML line breaks inside vertex labels [#824](https://github.com/knsv/mermaid/pull/824) ([jsyang](https://github.com/jsyang)) -* fixed diagrams [#810](https://github.com/knsv/mermaid/pull/810) ([0xflotus](https://github.com/0xflotus)) -* Clickable gantt tasks [#804](https://github.com/knsv/mermaid/pull/804) ([abzicht](https://github.com/abzicht)) -* linkStyle now supports list of indexes with a few tests [#798](https://github.com/knsv/mermaid/pull/798) ([ivan-danilov](https://github.com/ivan-danilov)) -* fix class diagram mermaid [#795](https://github.com/knsv/mermaid/pull/795) ([DanShai](https://github.com/DanShai)) -* Added exclude weekdays to definition [#792](https://github.com/knsv/mermaid/pull/792) ([jopapo](https://github.com/jopapo)) -* SVG link rendering [#791](https://github.com/knsv/mermaid/pull/791) ([flying-sheep](https://github.com/flying-sheep)) -* Gantt milestones [#788](https://github.com/knsv/mermaid/pull/788) ([gijswijs](https://github.com/gijswijs)) -* Remove duplicate code [#768](https://github.com/knsv/mermaid/pull/768) ([znxkznxk1030](https://github.com/znxkznxk1030)) -* Render nodes as real links [#765](https://github.com/knsv/mermaid/pull/765) ([flying-sheep](https://github.com/flying-sheep)) -* Fix issue with marker-end. [#757](https://github.com/knsv/mermaid/pull/757) ([gjlubbertsen](https://github.com/gjlubbertsen)) -* Make Class Diagrams usable in Stackedit and Live Editor [#749](https://github.com/knsv/mermaid/pull/749) ([monsterkrampe](https://github.com/monsterkrampe)) -* 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 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)) -* 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)) -* 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)) +- Remove console.log in classDB. [#861](https://github.com/knsv/mermaid/pull/861) ([Arthaey](https://github.com/Arthaey)) +- Bump sshpk from 1.13.1 to 1.16.1 [#851](https://github.com/knsv/mermaid/pull/851) ([dependabot\[bot\]](https://github.com/apps/dependabot)) +- Significantly smaller bundles [#850](https://github.com/knsv/mermaid/pull/850) ([fabiospampinato](https://github.com/fabiospampinato)) +- Support styling of subgraphs [#845](https://github.com/knsv/mermaid/pull/845) ([Qix-](https://github.com/Qix-)) +- fix dark theme loop labels not visible [#837](https://github.com/knsv/mermaid/pull/837) ([jnnnnn](https://github.com/jnnnnn)) +- fix draw function can only call once [#832](https://github.com/knsv/mermaid/pull/832) ([vaniship](https://github.com/vaniship)) +- Fix dotted lines not appearing in flowcharts when HTML labels disabled [#828](https://github.com/knsv/mermaid/pull/828) ([stanhu](https://github.com/stanhu)) +- Fix issue with XML line breaks inside vertex labels [#824](https://github.com/knsv/mermaid/pull/824) ([jsyang](https://github.com/jsyang)) +- fixed diagrams [#810](https://github.com/knsv/mermaid/pull/810) ([0xflotus](https://github.com/0xflotus)) +- Clickable gantt tasks [#804](https://github.com/knsv/mermaid/pull/804) ([abzicht](https://github.com/abzicht)) +- linkStyle now supports list of indexes with a few tests [#798](https://github.com/knsv/mermaid/pull/798) ([ivan-danilov](https://github.com/ivan-danilov)) +- fix class diagram mermaid [#795](https://github.com/knsv/mermaid/pull/795) ([DanShai](https://github.com/DanShai)) +- Added exclude weekdays to definition [#792](https://github.com/knsv/mermaid/pull/792) ([jopapo](https://github.com/jopapo)) +- SVG link rendering [#791](https://github.com/knsv/mermaid/pull/791) ([flying-sheep](https://github.com/flying-sheep)) +- Gantt milestones [#788](https://github.com/knsv/mermaid/pull/788) ([gijswijs](https://github.com/gijswijs)) +- Remove duplicate code [#768](https://github.com/knsv/mermaid/pull/768) ([znxkznxk1030](https://github.com/znxkznxk1030)) +- Render nodes as real links [#765](https://github.com/knsv/mermaid/pull/765) ([flying-sheep](https://github.com/flying-sheep)) +- Fix issue with marker-end. [#757](https://github.com/knsv/mermaid/pull/757) ([gjlubbertsen](https://github.com/gjlubbertsen)) +- Make Class Diagrams usable in Stackedit and Live Editor [#749](https://github.com/knsv/mermaid/pull/749) ([monsterkrampe](https://github.com/monsterkrampe)) +- 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 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)) +- 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)) +- 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)) ## [7.0.5](https://github.com/knsv/mermaid/tree/7.0.5) (2017-09-01) @@ -358,23 +360,23 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* live editor latin error after update [#560](https://github.com/knsv/mermaid/issues/560) -* Simple full example in online documentation is broken [#558](https://github.com/knsv/mermaid/issues/558) -* Graph No Arrow Head v7.0.3 [#543](https://github.com/knsv/mermaid/issues/543) -* Conflict while using mermaid along with core-js [#512](https://github.com/knsv/mermaid/issues/512) -* Export to pdf on website [#496](https://github.com/knsv/mermaid/issues/496) -* New downstream project: Mermaid Preview for VSCode [#442](https://github.com/knsv/mermaid/issues/442) -* Can't Zoom the flowchart ? [#399](https://github.com/knsv/mermaid/issues/399) -* line labels are not rendered correctly in live editor [#366](https://github.com/knsv/mermaid/issues/366) -* mermaid-loader [#361](https://github.com/knsv/mermaid/issues/361) -* Are there any documentation or examples for classDiagram and gitGraph? [#359](https://github.com/knsv/mermaid/issues/359) -* \# character broken in 0.5.8 [#347](https://github.com/knsv/mermaid/issues/347) -* Documentation issue: CSS example is not visible [#345](https://github.com/knsv/mermaid/issues/345) -* Include documentation for command line usage [#326](https://github.com/knsv/mermaid/issues/326) -* Fresh fork: can't build dist [#296](https://github.com/knsv/mermaid/issues/296) -* Invalid value for \ attribute viewBox="0 0 -Infinity -Infinity" [#291](https://github.com/knsv/mermaid/issues/291) -* Webpack require fails [#277](https://github.com/knsv/mermaid/issues/277) -* New documentation - need improved logo [#216](https://github.com/knsv/mermaid/issues/216) +- live editor latin error after update [#560](https://github.com/knsv/mermaid/issues/560) +- Simple full example in online documentation is broken [#558](https://github.com/knsv/mermaid/issues/558) +- Graph No Arrow Head v7.0.3 [#543](https://github.com/knsv/mermaid/issues/543) +- Conflict while using mermaid along with core-js [#512](https://github.com/knsv/mermaid/issues/512) +- Export to pdf on website [#496](https://github.com/knsv/mermaid/issues/496) +- New downstream project: Mermaid Preview for VSCode [#442](https://github.com/knsv/mermaid/issues/442) +- Can't Zoom the flowchart ? [#399](https://github.com/knsv/mermaid/issues/399) +- line labels are not rendered correctly in live editor [#366](https://github.com/knsv/mermaid/issues/366) +- mermaid-loader [#361](https://github.com/knsv/mermaid/issues/361) +- Are there any documentation or examples for classDiagram and gitGraph? [#359](https://github.com/knsv/mermaid/issues/359) +- \# character broken in 0.5.8 [#347](https://github.com/knsv/mermaid/issues/347) +- Documentation issue: CSS example is not visible [#345](https://github.com/knsv/mermaid/issues/345) +- Include documentation for command line usage [#326](https://github.com/knsv/mermaid/issues/326) +- Fresh fork: can't build dist [#296](https://github.com/knsv/mermaid/issues/296) +- Invalid value for \ attribute viewBox="0 0 -Infinity -Infinity" [#291](https://github.com/knsv/mermaid/issues/291) +- Webpack require fails [#277](https://github.com/knsv/mermaid/issues/277) +- 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) @@ -382,8 +384,8 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* the documentation website is down [#539](https://github.com/knsv/mermaid/issues/539) -* Good example of interactivity with mermaidAPI [#514](https://github.com/knsv/mermaid/issues/514) +- the documentation website is down [#539](https://github.com/knsv/mermaid/issues/539) +- 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) @@ -391,37 +393,37 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* CDN is not working [#511](https://github.com/knsv/mermaid/issues/511) -* A sampe sequenceDiagram crashes mermaid-cli [#492](https://github.com/knsv/mermaid/issues/492) -* Mermaid doesn't delete nodes when called multiple times [#491](https://github.com/knsv/mermaid/issues/491) -* API crashes on 2nd render() call [#478](https://github.com/knsv/mermaid/issues/478) -* sequenceDiagram: dotted line for alt and empty bracket should be hidden [#456](https://github.com/knsv/mermaid/issues/456) -* SVG output (almost) not correct [#434](https://github.com/knsv/mermaid/issues/434) -* How to set axisFormatter of gantt in mermaid CLI? [#428](https://github.com/knsv/mermaid/issues/428) -* customizing link style with any color sets `fill` property to `black` instead of `none` [#416](https://github.com/knsv/mermaid/issues/416) -* New line at the end of SVG file [#400](https://github.com/knsv/mermaid/issues/400) -* CLI doesn't work [#389](https://github.com/knsv/mermaid/issues/389) -* Can't render subgraphs with htmlLabels: false [#367](https://github.com/knsv/mermaid/issues/367) -* Color arrowhead [#362](https://github.com/knsv/mermaid/issues/362) -* CLI: Invisible text, lines in SVG output [#341](https://github.com/knsv/mermaid/issues/341) +- CDN is not working [#511](https://github.com/knsv/mermaid/issues/511) +- A sampe sequenceDiagram crashes mermaid-cli [#492](https://github.com/knsv/mermaid/issues/492) +- Mermaid doesn't delete nodes when called multiple times [#491](https://github.com/knsv/mermaid/issues/491) +- API crashes on 2nd render() call [#478](https://github.com/knsv/mermaid/issues/478) +- sequenceDiagram: dotted line for alt and empty bracket should be hidden [#456](https://github.com/knsv/mermaid/issues/456) +- SVG output (almost) not correct [#434](https://github.com/knsv/mermaid/issues/434) +- How to set axisFormatter of gantt in mermaid CLI? [#428](https://github.com/knsv/mermaid/issues/428) +- customizing link style with any color sets `fill` property to `black` instead of `none` [#416](https://github.com/knsv/mermaid/issues/416) +- New line at the end of SVG file [#400](https://github.com/knsv/mermaid/issues/400) +- CLI doesn't work [#389](https://github.com/knsv/mermaid/issues/389) +- Can't render subgraphs with htmlLabels: false [#367](https://github.com/knsv/mermaid/issues/367) +- Color arrowhead [#362](https://github.com/knsv/mermaid/issues/362) +- CLI: Invisible text, lines in SVG output [#341](https://github.com/knsv/mermaid/issues/341) **Merged pull requests:** -* Support Multi-line Actor Descriptions [#764](https://github.com/knsv/mermaid/pull/764) ([watsoncj](https://github.com/watsoncj)) -* Update Travis config [#538](https://github.com/knsv/mermaid/pull/538) ([tylerlong](https://github.com/tylerlong)) -* Fix spelling of 'you' in sequenceDiagram docs [#537](https://github.com/knsv/mermaid/pull/537) ([ctruelson](https://github.com/ctruelson)) -* Improve CLI output [#536](https://github.com/knsv/mermaid/pull/536) ([gibson042](https://github.com/gibson042)) -* Modernize mermaid [#524](https://github.com/knsv/mermaid/pull/524) ([tylerlong](https://github.com/tylerlong)) -* Modernize mermaid [#519](https://github.com/knsv/mermaid/pull/519) ([tylerlong](https://github.com/tylerlong)) -* Update CLI instructions [#509](https://github.com/knsv/mermaid/pull/509) ([filipedeschamps](https://github.com/filipedeschamps)) -* Add style for classDiagram to dark/default theme [#503](https://github.com/knsv/mermaid/pull/503) ([yudenzel](https://github.com/yudenzel)) -* Fix documentation for git graph. [#498](https://github.com/knsv/mermaid/pull/498) ([gomlgs](https://github.com/gomlgs)) -* Fix links in documentations [#497](https://github.com/knsv/mermaid/pull/497) ([saveman71](https://github.com/saveman71)) -* Update README.md with git graph sample [#481](https://github.com/knsv/mermaid/pull/481) ([raghur](https://github.com/raghur)) -* Fix misspelling of “another” [#479](https://github.com/knsv/mermaid/pull/479) ([stevenschobert](https://github.com/stevenschobert)) -* Fixed #456 sequenceDiagram: dotted line for alt and empty bracket sho… [#477](https://github.com/knsv/mermaid/pull/477) ([brookhong](https://github.com/brookhong)) -* Add viewbox attr to class diagram [#473](https://github.com/knsv/mermaid/pull/473) ([gnkm](https://github.com/gnkm)) -* add par statement to sequenceDiagram [#470](https://github.com/knsv/mermaid/pull/470) ([u-minor](https://github.com/u-minor)) +- Support Multi-line Actor Descriptions [#764](https://github.com/knsv/mermaid/pull/764) ([watsoncj](https://github.com/watsoncj)) +- Update Travis config [#538](https://github.com/knsv/mermaid/pull/538) ([tylerlong](https://github.com/tylerlong)) +- Fix spelling of 'you' in sequenceDiagram docs [#537](https://github.com/knsv/mermaid/pull/537) ([ctruelson](https://github.com/ctruelson)) +- Improve CLI output [#536](https://github.com/knsv/mermaid/pull/536) ([gibson042](https://github.com/gibson042)) +- Modernize mermaid [#524](https://github.com/knsv/mermaid/pull/524) ([tylerlong](https://github.com/tylerlong)) +- Modernize mermaid [#519](https://github.com/knsv/mermaid/pull/519) ([tylerlong](https://github.com/tylerlong)) +- Update CLI instructions [#509](https://github.com/knsv/mermaid/pull/509) ([filipedeschamps](https://github.com/filipedeschamps)) +- Add style for classDiagram to dark/default theme [#503](https://github.com/knsv/mermaid/pull/503) ([yudenzel](https://github.com/yudenzel)) +- Fix documentation for git graph. [#498](https://github.com/knsv/mermaid/pull/498) ([gomlgs](https://github.com/gomlgs)) +- Fix links in documentations [#497](https://github.com/knsv/mermaid/pull/497) ([saveman71](https://github.com/saveman71)) +- Update README.md with git graph sample [#481](https://github.com/knsv/mermaid/pull/481) ([raghur](https://github.com/raghur)) +- Fix misspelling of “another” [#479](https://github.com/knsv/mermaid/pull/479) ([stevenschobert](https://github.com/stevenschobert)) +- Fixed #456 sequenceDiagram: dotted line for alt and empty bracket sho… [#477](https://github.com/knsv/mermaid/pull/477) ([brookhong](https://github.com/brookhong)) +- Add viewbox attr to class diagram [#473](https://github.com/knsv/mermaid/pull/473) ([gnkm](https://github.com/gnkm)) +- 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) @@ -429,53 +431,53 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* npm install -g mermaid does not install phantomjs [#329](https://github.com/knsv/mermaid/issues/329) -* activation boxes [#313](https://github.com/knsv/mermaid/issues/313) +- npm install -g mermaid does not install phantomjs [#329](https://github.com/knsv/mermaid/issues/329) +- activation boxes [#313](https://github.com/knsv/mermaid/issues/313) **Closed issues:** -* demos on io site not working [#466](https://github.com/knsv/mermaid/issues/466) -* 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) -* 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) -* 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) -* uncaught TypeError: t.getTransformToElement is not a function [#401](https://github.com/knsv/mermaid/issues/401) -* Only works when using browserify'd code [#373](https://github.com/knsv/mermaid/issues/373) -* document the use of shebang line in mmd files [#364](https://github.com/knsv/mermaid/issues/364) -* Diagrams are small and unreadable in IE 11 - since 0.5.1 [#356](https://github.com/knsv/mermaid/issues/356) -* \[Feature Request] ER-Diagram Support [#354](https://github.com/knsv/mermaid/issues/354) -* The need for mermaid.css should be mentioned explicitly in the intro docs... [#273](https://github.com/knsv/mermaid/issues/273) +- demos on io site not working [#466](https://github.com/knsv/mermaid/issues/466) +- 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) +- 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) +- 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) +- uncaught TypeError: t.getTransformToElement is not a function [#401](https://github.com/knsv/mermaid/issues/401) +- Only works when using browserify'd code [#373](https://github.com/knsv/mermaid/issues/373) +- document the use of shebang line in mmd files [#364](https://github.com/knsv/mermaid/issues/364) +- Diagrams are small and unreadable in IE 11 - since 0.5.1 [#356](https://github.com/knsv/mermaid/issues/356) +- \[Feature Request] ER-Diagram Support [#354](https://github.com/knsv/mermaid/issues/354) +- The need for mermaid.css should be mentioned explicitly in the intro docs... [#273](https://github.com/knsv/mermaid/issues/273) **Merged pull requests:** -* Update index.html [#465](https://github.com/knsv/mermaid/pull/465) ([bmsleight](https://github.com/bmsleight)) -* Fix for #416, customizing link style with any color sets `fill` property to `black` instead of `none` [#452](https://github.com/knsv/mermaid/pull/452) ([joshuacolvin](https://github.com/joshuacolvin)) -* Allow .node>circle to receive css styles [#449](https://github.com/knsv/mermaid/pull/449) ([bfriedz](https://github.com/bfriedz)) -* Fix spelling [#447](https://github.com/knsv/mermaid/pull/447) ([jawn](https://github.com/jawn)) -* added tests and fix cli css style selector lowercase problem [#445](https://github.com/knsv/mermaid/pull/445) ([whyzdev](https://github.com/whyzdev)) -* Update d3.js [#441](https://github.com/knsv/mermaid/pull/441) ([hetz](https://github.com/hetz)) -* added tests to reproduce #434 in flowchart [#439](https://github.com/knsv/mermaid/pull/439) ([whyzdev](https://github.com/whyzdev)) -* Code Climate config [#437](https://github.com/knsv/mermaid/pull/437) ([larkinscott](https://github.com/larkinscott)) -* fix gantt and sequence digram cli cfg [#435](https://github.com/knsv/mermaid/pull/435) ([whyzdev](https://github.com/whyzdev)) -* fix gantt chart cli configuration broken [#433](https://github.com/knsv/mermaid/pull/433) ([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)) -* 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)) -* 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)) -* update usage and fix #273 [#406](https://github.com/knsv/mermaid/pull/406) ([jinntrance](https://github.com/jinntrance)) -* Add https://github.com/raghur/mermaid-filter to downstream projects docs page [#404](https://github.com/knsv/mermaid/pull/404) ([raghur](https://github.com/raghur)) -* New neutral theme [#395](https://github.com/knsv/mermaid/pull/395) ([sinedied](https://github.com/sinedied)) -* fix cli issues [#390](https://github.com/knsv/mermaid/pull/390) ([ben-page](https://github.com/ben-page)) -* Add missing space for 'Labels out of bounds' section [#386](https://github.com/knsv/mermaid/pull/386) ([The-Alchemist](https://github.com/The-Alchemist)) -* Fix typo: `pats` -> `paths` [#382](https://github.com/knsv/mermaid/pull/382) ([swhgoon](https://github.com/swhgoon)) -* Added class diagram example to README.md [#379](https://github.com/knsv/mermaid/pull/379) ([HustLion](https://github.com/HustLion)) -* override normal flowchart arrowhead to allow css styling [#376](https://github.com/knsv/mermaid/pull/376) ([dodoinblue](https://github.com/dodoinblue)) -* added sphinx extension [#371](https://github.com/knsv/mermaid/pull/371) ([mgaitan](https://github.com/mgaitan)) -* Fix typo in the sequence diagram documentation [#369](https://github.com/knsv/mermaid/pull/369) ([ggpasqualino](https://github.com/ggpasqualino)) +- Update index.html [#465](https://github.com/knsv/mermaid/pull/465) ([bmsleight](https://github.com/bmsleight)) +- Fix for #416, customizing link style with any color sets `fill` property to `black` instead of `none` [#452](https://github.com/knsv/mermaid/pull/452) ([joshuacolvin](https://github.com/joshuacolvin)) +- Allow .node>circle to receive css styles [#449](https://github.com/knsv/mermaid/pull/449) ([bfriedz](https://github.com/bfriedz)) +- Fix spelling [#447](https://github.com/knsv/mermaid/pull/447) ([jawn](https://github.com/jawn)) +- added tests and fix cli css style selector lowercase problem [#445](https://github.com/knsv/mermaid/pull/445) ([whyzdev](https://github.com/whyzdev)) +- Update d3.js [#441](https://github.com/knsv/mermaid/pull/441) ([hetz](https://github.com/hetz)) +- added tests to reproduce #434 in flowchart [#439](https://github.com/knsv/mermaid/pull/439) ([whyzdev](https://github.com/whyzdev)) +- Code Climate config [#437](https://github.com/knsv/mermaid/pull/437) ([larkinscott](https://github.com/larkinscott)) +- fix gantt and sequence digram cli cfg [#435](https://github.com/knsv/mermaid/pull/435) ([whyzdev](https://github.com/whyzdev)) +- fix gantt chart cli configuration broken [#433](https://github.com/knsv/mermaid/pull/433) ([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)) +- 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)) +- 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)) +- update usage and fix #273 [#406](https://github.com/knsv/mermaid/pull/406) ([jinntrance](https://github.com/jinntrance)) +- Add https://github.com/raghur/mermaid-filter to downstream projects docs page [#404](https://github.com/knsv/mermaid/pull/404) ([raghur](https://github.com/raghur)) +- New neutral theme [#395](https://github.com/knsv/mermaid/pull/395) ([sinedied](https://github.com/sinedied)) +- fix cli issues [#390](https://github.com/knsv/mermaid/pull/390) ([ben-page](https://github.com/ben-page)) +- Add missing space for 'Labels out of bounds' section [#386](https://github.com/knsv/mermaid/pull/386) ([The-Alchemist](https://github.com/The-Alchemist)) +- Fix typo: `pats` -> `paths` [#382](https://github.com/knsv/mermaid/pull/382) ([swhgoon](https://github.com/swhgoon)) +- Added class diagram example to README.md [#379](https://github.com/knsv/mermaid/pull/379) ([HustLion](https://github.com/HustLion)) +- override normal flowchart arrowhead to allow css styling [#376](https://github.com/knsv/mermaid/pull/376) ([dodoinblue](https://github.com/dodoinblue)) +- added sphinx extension [#371](https://github.com/knsv/mermaid/pull/371) ([mgaitan](https://github.com/mgaitan)) +- 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) @@ -483,38 +485,38 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* Docs css: code hard to read [#324](https://github.com/knsv/mermaid/issues/324) -* About Markpad integration [#323](https://github.com/knsv/mermaid/issues/323) -* How to link backwards in flowchart? [#321](https://github.com/knsv/mermaid/issues/321) -* Help with editor [#310](https://github.com/knsv/mermaid/issues/310) -* \+1 [#293](https://github.com/knsv/mermaid/issues/293) -* Basic chart does not render on Chome, but does in Firefox [#290](https://github.com/knsv/mermaid/issues/290) -* Live editor is broken [#285](https://github.com/knsv/mermaid/issues/285) -* "No such file or directory" trying to run mermaid 0.5.7 on OS X [#284](https://github.com/knsv/mermaid/issues/284) -* participant name as "Long Long Name" [#283](https://github.com/knsv/mermaid/issues/283) -* Windows - cli - could not find phantomjs at the specified path [#236](https://github.com/knsv/mermaid/issues/236) +- Docs css: code hard to read [#324](https://github.com/knsv/mermaid/issues/324) +- About Markpad integration [#323](https://github.com/knsv/mermaid/issues/323) +- How to link backwards in flowchart? [#321](https://github.com/knsv/mermaid/issues/321) +- Help with editor [#310](https://github.com/knsv/mermaid/issues/310) +- \+1 [#293](https://github.com/knsv/mermaid/issues/293) +- Basic chart does not render on Chome, but does in Firefox [#290](https://github.com/knsv/mermaid/issues/290) +- Live editor is broken [#285](https://github.com/knsv/mermaid/issues/285) +- "No such file or directory" trying to run mermaid 0.5.7 on OS X [#284](https://github.com/knsv/mermaid/issues/284) +- participant name as "Long Long Name" [#283](https://github.com/knsv/mermaid/issues/283) +- Windows - cli - could not find phantomjs at the specified path [#236](https://github.com/knsv/mermaid/issues/236) **Merged pull requests:** -* The option of gantt for the spaces for the section names. [#353](https://github.com/knsv/mermaid/pull/353) ([zeroyonichihachi](https://github.com/zeroyonichihachi)) -* Gitgraph: Make reset work with parent ref carets [#350](https://github.com/knsv/mermaid/pull/350) ([raghur](https://github.com/raghur)) -* Remove the text-shadows that make the text look blurry [#349](https://github.com/knsv/mermaid/pull/349) ([AsaAyers](https://github.com/AsaAyers)) -* add line interpolation to linkStyle in flowchart [#346](https://github.com/knsv/mermaid/pull/346) ([AlanHohn](https://github.com/AlanHohn)) -* Support git graph diagrams in mermaid [#344](https://github.com/knsv/mermaid/pull/344) ([raghur](https://github.com/raghur)) -* Build and test execution changes [#338](https://github.com/knsv/mermaid/pull/338) ([ssbarnea](https://github.com/ssbarnea)) -* Reformatting of css files [#331](https://github.com/knsv/mermaid/pull/331) ([Jmuccigr](https://github.com/Jmuccigr)) -* (WIP) Sequence Diagram Title Support [#320](https://github.com/knsv/mermaid/pull/320) ([bronsoja](https://github.com/bronsoja)) -* activations doc + few fixes [#318](https://github.com/knsv/mermaid/pull/318) ([ciekawy](https://github.com/ciekawy)) -* Dark theme for better contrast on darker backgrounds [#317](https://github.com/knsv/mermaid/pull/317) ([crodriguez1a](https://github.com/crodriguez1a)) -* Activations [#316](https://github.com/knsv/mermaid/pull/316) ([ciekawy](https://github.com/ciekawy)) -* Support leading comments for sequenceDiagrams [#312](https://github.com/knsv/mermaid/pull/312) ([ashsearle](https://github.com/ashsearle)) -* Show a little lenience for white-space around names [#309](https://github.com/knsv/mermaid/pull/309) ([ashsearle](https://github.com/ashsearle)) -* Update list of downstream projects [#307](https://github.com/knsv/mermaid/pull/307) ([maxArturo](https://github.com/maxArturo)) -* Issue 299: Sequence diagram Loops: changing boxMargin spoils the "loop" notation [#300](https://github.com/knsv/mermaid/pull/300) ([LarryKlugerDS](https://github.com/LarryKlugerDS)) -* Issue 297 - src/mermaid.js generates bad code [#298](https://github.com/knsv/mermaid/pull/298) ([LarryKlugerDS](https://github.com/LarryKlugerDS)) -* Updated instructions for running tests [#295](https://github.com/knsv/mermaid/pull/295) ([LarryKlugerDS](https://github.com/LarryKlugerDS)) -* Add Markdown Plus to Downstream projects [#288](https://github.com/knsv/mermaid/pull/288) ([tylerlong](https://github.com/tylerlong)) -* Quote phantomPath so that it doesn't fail on window [#286](https://github.com/knsv/mermaid/pull/286) ([raghur](https://github.com/raghur)) +- The option of gantt for the spaces for the section names. [#353](https://github.com/knsv/mermaid/pull/353) ([zeroyonichihachi](https://github.com/zeroyonichihachi)) +- Gitgraph: Make reset work with parent ref carets [#350](https://github.com/knsv/mermaid/pull/350) ([raghur](https://github.com/raghur)) +- Remove the text-shadows that make the text look blurry [#349](https://github.com/knsv/mermaid/pull/349) ([AsaAyers](https://github.com/AsaAyers)) +- add line interpolation to linkStyle in flowchart [#346](https://github.com/knsv/mermaid/pull/346) ([AlanHohn](https://github.com/AlanHohn)) +- Support git graph diagrams in mermaid [#344](https://github.com/knsv/mermaid/pull/344) ([raghur](https://github.com/raghur)) +- Build and test execution changes [#338](https://github.com/knsv/mermaid/pull/338) ([ssbarnea](https://github.com/ssbarnea)) +- Reformatting of css files [#331](https://github.com/knsv/mermaid/pull/331) ([Jmuccigr](https://github.com/Jmuccigr)) +- (WIP) Sequence Diagram Title Support [#320](https://github.com/knsv/mermaid/pull/320) ([bronsoja](https://github.com/bronsoja)) +- activations doc + few fixes [#318](https://github.com/knsv/mermaid/pull/318) ([ciekawy](https://github.com/ciekawy)) +- Dark theme for better contrast on darker backgrounds [#317](https://github.com/knsv/mermaid/pull/317) ([crodriguez1a](https://github.com/crodriguez1a)) +- Activations [#316](https://github.com/knsv/mermaid/pull/316) ([ciekawy](https://github.com/ciekawy)) +- Support leading comments for sequenceDiagrams [#312](https://github.com/knsv/mermaid/pull/312) ([ashsearle](https://github.com/ashsearle)) +- Show a little lenience for white-space around names [#309](https://github.com/knsv/mermaid/pull/309) ([ashsearle](https://github.com/ashsearle)) +- Update list of downstream projects [#307](https://github.com/knsv/mermaid/pull/307) ([maxArturo](https://github.com/maxArturo)) +- Issue 299: Sequence diagram Loops: changing boxMargin spoils the "loop" notation [#300](https://github.com/knsv/mermaid/pull/300) ([LarryKlugerDS](https://github.com/LarryKlugerDS)) +- Issue 297 - src/mermaid.js generates bad code [#298](https://github.com/knsv/mermaid/pull/298) ([LarryKlugerDS](https://github.com/LarryKlugerDS)) +- Updated instructions for running tests [#295](https://github.com/knsv/mermaid/pull/295) ([LarryKlugerDS](https://github.com/LarryKlugerDS)) +- Add Markdown Plus to Downstream projects [#288](https://github.com/knsv/mermaid/pull/288) ([tylerlong](https://github.com/tylerlong)) +- 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) @@ -526,21 +528,21 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* Mermaid + LightPaper = ❤️ [#280](https://github.com/knsv/mermaid/issues/280) -* Bower Integration [#278](https://github.com/knsv/mermaid/issues/278) -* Mermaid breaks when variables end in 'v' [#276](https://github.com/knsv/mermaid/issues/276) -* sequence diagrams don't support participant aliasing [#263](https://github.com/knsv/mermaid/issues/263) -* One diagram that fails to render stops further execution on the page [#259](https://github.com/knsv/mermaid/issues/259) -* Where to find line layout algorithm? [#258](https://github.com/knsv/mermaid/issues/258) -* Compatibility with node.js [#257](https://github.com/knsv/mermaid/issues/257) -* Label resizing with dynamically loaded fonts [#255](https://github.com/knsv/mermaid/issues/255) -* SVG arrowheads are broken in the CLI [#249](https://github.com/knsv/mermaid/issues/249) -* Cannot read property 'replace' of undefined [#239](https://github.com/knsv/mermaid/issues/239) +- Mermaid + LightPaper = ❤️ [#280](https://github.com/knsv/mermaid/issues/280) +- Bower Integration [#278](https://github.com/knsv/mermaid/issues/278) +- Mermaid breaks when variables end in 'v' [#276](https://github.com/knsv/mermaid/issues/276) +- sequence diagrams don't support participant aliasing [#263](https://github.com/knsv/mermaid/issues/263) +- One diagram that fails to render stops further execution on the page [#259](https://github.com/knsv/mermaid/issues/259) +- Where to find line layout algorithm? [#258](https://github.com/knsv/mermaid/issues/258) +- Compatibility with node.js [#257](https://github.com/knsv/mermaid/issues/257) +- Label resizing with dynamically loaded fonts [#255](https://github.com/knsv/mermaid/issues/255) +- SVG arrowheads are broken in the CLI [#249](https://github.com/knsv/mermaid/issues/249) +- Cannot read property 'replace' of undefined [#239](https://github.com/knsv/mermaid/issues/239) **Merged pull requests:** -* gh-50 Allow styling of edge labels in css [#267](https://github.com/knsv/mermaid/pull/267) ([Anoia](https://github.com/Anoia)) -* Allow sequenceDiagram participant aliasing [#265](https://github.com/knsv/mermaid/pull/265) ([gibson042](https://github.com/gibson042)) +- gh-50 Allow styling of edge labels in css [#267](https://github.com/knsv/mermaid/pull/267) ([Anoia](https://github.com/Anoia)) +- 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) @@ -548,36 +550,36 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Add download SVG link to the live editor [#144](https://github.com/knsv/mermaid/issues/144) +- Add download SVG link to the live editor [#144](https://github.com/knsv/mermaid/issues/144) **Fixed bugs:** -* Live Editor: Permalink address not being parsed [#202](https://github.com/knsv/mermaid/issues/202) +- Live Editor: Permalink address not being parsed [#202](https://github.com/knsv/mermaid/issues/202) **Closed issues:** -* title doesn't work in sequenceDiagram [#248](https://github.com/knsv/mermaid/issues/248) -* hypen-minus should be valid in sequence diagram alt/else/etc. descriptions [#247](https://github.com/knsv/mermaid/issues/247) -* Broken in firefox? [#245](https://github.com/knsv/mermaid/issues/245) -* When there is a Chinese symbol in the flowchart, it will crash。 [#238](https://github.com/knsv/mermaid/issues/238) -* Non-alpha characters included in ALPHA token (flow graph jison) [#232](https://github.com/knsv/mermaid/issues/232) -* subgraph not rendering with change to sample [#231](https://github.com/knsv/mermaid/issues/231) -* sequence diagram requires a new line at the end? [#229](https://github.com/knsv/mermaid/issues/229) +- title doesn't work in sequenceDiagram [#248](https://github.com/knsv/mermaid/issues/248) +- hypen-minus should be valid in sequence diagram alt/else/etc. descriptions [#247](https://github.com/knsv/mermaid/issues/247) +- Broken in firefox? [#245](https://github.com/knsv/mermaid/issues/245) +- When there is a Chinese symbol in the flowchart, it will crash。 [#238](https://github.com/knsv/mermaid/issues/238) +- Non-alpha characters included in ALPHA token (flow graph jison) [#232](https://github.com/knsv/mermaid/issues/232) +- subgraph not rendering with change to sample [#231](https://github.com/knsv/mermaid/issues/231) +- sequence diagram requires a new line at the end? [#229](https://github.com/knsv/mermaid/issues/229) **Merged pull requests:** -* Make sequenceDiagram terminal newline optional [#253](https://github.com/knsv/mermaid/pull/253) ([gibson042](https://github.com/gibson042)) -* Support sequenceDiagram "over" notes [#252](https://github.com/knsv/mermaid/pull/252) ([gibson042](https://github.com/gibson042)) -* Properly handle "rest of line" statements [#251](https://github.com/knsv/mermaid/pull/251) ([gibson042](https://github.com/gibson042)) -* CLI: Propagate exit code from lib (i.e., phantomjs) [#250](https://github.com/knsv/mermaid/pull/250) ([gibson042](https://github.com/gibson042)) -* flowRender.js - Fix FontAwesome icon insert [#244](https://github.com/knsv/mermaid/pull/244) ([ma-zal](https://github.com/ma-zal)) -* updated sequence diagram link in live editor [#242](https://github.com/knsv/mermaid/pull/242) ([r-a-v-a-s](https://github.com/r-a-v-a-s)) -* updated links in README.md [#240](https://github.com/knsv/mermaid/pull/240) ([r-a-v-a-s](https://github.com/r-a-v-a-s)) -* Ellipse syntax [#237](https://github.com/knsv/mermaid/pull/237) ([spect88](https://github.com/spect88)) -* Allow keywords as suffixes of node ids [#235](https://github.com/knsv/mermaid/pull/235) ([spect88](https://github.com/spect88)) -* Highlighted the editor in the nav [#234](https://github.com/knsv/mermaid/pull/234) ([knsv](https://github.com/knsv)) -* Live editor tweaks [#233](https://github.com/knsv/mermaid/pull/233) ([spect88](https://github.com/spect88)) -* Add a Gitter chat badge to README.md [#230](https://github.com/knsv/mermaid/pull/230) ([gitter-badger](https://github.com/gitter-badger)) +- Make sequenceDiagram terminal newline optional [#253](https://github.com/knsv/mermaid/pull/253) ([gibson042](https://github.com/gibson042)) +- Support sequenceDiagram "over" notes [#252](https://github.com/knsv/mermaid/pull/252) ([gibson042](https://github.com/gibson042)) +- Properly handle "rest of line" statements [#251](https://github.com/knsv/mermaid/pull/251) ([gibson042](https://github.com/gibson042)) +- CLI: Propagate exit code from lib (i.e., phantomjs) [#250](https://github.com/knsv/mermaid/pull/250) ([gibson042](https://github.com/gibson042)) +- flowRender.js - Fix FontAwesome icon insert [#244](https://github.com/knsv/mermaid/pull/244) ([ma-zal](https://github.com/ma-zal)) +- updated sequence diagram link in live editor [#242](https://github.com/knsv/mermaid/pull/242) ([r-a-v-a-s](https://github.com/r-a-v-a-s)) +- updated links in README.md [#240](https://github.com/knsv/mermaid/pull/240) ([r-a-v-a-s](https://github.com/r-a-v-a-s)) +- Ellipse syntax [#237](https://github.com/knsv/mermaid/pull/237) ([spect88](https://github.com/spect88)) +- Allow keywords as suffixes of node ids [#235](https://github.com/knsv/mermaid/pull/235) ([spect88](https://github.com/spect88)) +- Highlighted the editor in the nav [#234](https://github.com/knsv/mermaid/pull/234) ([knsv](https://github.com/knsv)) +- Live editor tweaks [#233](https://github.com/knsv/mermaid/pull/233) ([spect88](https://github.com/spect88)) +- 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) @@ -585,11 +587,11 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* sequence diagram, arrowhead instead of crosshead [#227](https://github.com/knsv/mermaid/issues/227) +- sequence diagram, arrowhead instead of crosshead [#227](https://github.com/knsv/mermaid/issues/227) **Merged pull requests:** -* 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) @@ -597,25 +599,25 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Set log level from mermaid configuration [#220](https://github.com/knsv/mermaid/issues/220) -* Links in sequence diagrams [#159](https://github.com/knsv/mermaid/issues/159) -* Add syntax for double headed arrows [#123](https://github.com/knsv/mermaid/issues/123) +- Set log level from mermaid configuration [#220](https://github.com/knsv/mermaid/issues/220) +- Links in sequence diagrams [#159](https://github.com/knsv/mermaid/issues/159) +- Add syntax for double headed arrows [#123](https://github.com/knsv/mermaid/issues/123) **Fixed bugs:** -* comment characters `%%` cause parse error [#141](https://github.com/knsv/mermaid/issues/141) +- comment characters `%%` cause parse error [#141](https://github.com/knsv/mermaid/issues/141) **Closed issues:** -* Marker-end arrow cannot be shown for URL with query parameter [#225](https://github.com/knsv/mermaid/issues/225) -* Please update bower's D3 version [#221](https://github.com/knsv/mermaid/issues/221) -* Width fixed to 400px [#204](https://github.com/knsv/mermaid/issues/204) -* render to png from the cli does not display the marker-end arrow heads [#181](https://github.com/knsv/mermaid/issues/181) +- Marker-end arrow cannot be shown for URL with query parameter [#225](https://github.com/knsv/mermaid/issues/225) +- Please update bower's D3 version [#221](https://github.com/knsv/mermaid/issues/221) +- Width fixed to 400px [#204](https://github.com/knsv/mermaid/issues/204) +- render to png from the cli does not display the marker-end arrow heads [#181](https://github.com/knsv/mermaid/issues/181) **Merged pull requests:** -* Allow `end` as a substring of vertex id [#224](https://github.com/knsv/mermaid/pull/224) ([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)) +- Allow `end` as a substring of vertex id [#224](https://github.com/knsv/mermaid/pull/224) ([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) @@ -627,52 +629,52 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Support for hyperlink and tooltip [#34](https://github.com/knsv/mermaid/issues/34) +- Support for hyperlink and tooltip [#34](https://github.com/knsv/mermaid/issues/34) **Closed issues:** -* Installing “atom-mermaid@0.1.3” failed [#218](https://github.com/knsv/mermaid/issues/218) -* node feature request [#211](https://github.com/knsv/mermaid/issues/211) -* 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) -* 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) -* 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) -* Static site does not render under HTTPS [#194](https://github.com/knsv/mermaid/issues/194) -* Error on simple graph [#192](https://github.com/knsv/mermaid/issues/192) -* Escape "~" [#191](https://github.com/knsv/mermaid/issues/191) -* Trying to add link using 'click' to flowchart [#188](https://github.com/knsv/mermaid/issues/188) -* cli: no lines and arrowheads rendered / only dotted lines [#187](https://github.com/knsv/mermaid/issues/187) -* text of mermaid div displayed on page [#186](https://github.com/knsv/mermaid/issues/186) -* using mermaid with laravel [#185](https://github.com/knsv/mermaid/issues/185) -* Atom editor package [#183](https://github.com/knsv/mermaid/issues/183) -* Auto linewrap for notes in sequence diagrams [#178](https://github.com/knsv/mermaid/issues/178) -* Execute code after initialize [#176](https://github.com/knsv/mermaid/issues/176) -* Autoscaling for all diagram types [#175](https://github.com/knsv/mermaid/issues/175) -* Problem wit click event callback [#174](https://github.com/knsv/mermaid/issues/174) -* How to escape characters? [#170](https://github.com/knsv/mermaid/issues/170) -* it can not work [#167](https://github.com/knsv/mermaid/issues/167) -* Broken subgraph using the CLI [#153](https://github.com/knsv/mermaid/issues/153) -* IE Support issue [#142](https://github.com/knsv/mermaid/issues/142) -* Flowchart truncated [#140](https://github.com/knsv/mermaid/issues/140) -* Double Quote as text is not working [#219](https://github.com/knsv/mermaid/issues/219) -* classDef / class not working with htmlLabels? [#210](https://github.com/knsv/mermaid/issues/210) -* Links in graph missing [#209](https://github.com/knsv/mermaid/issues/209) -* 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) -* SVG foreignObject rendering [#180](https://github.com/knsv/mermaid/issues/180) -* 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) -* \[Parser] Hyphen in participant name bring TypeError [#74](https://github.com/knsv/mermaid/issues/74) +- Installing “atom-mermaid@0.1.3” failed [#218](https://github.com/knsv/mermaid/issues/218) +- node feature request [#211](https://github.com/knsv/mermaid/issues/211) +- 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) +- 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) +- 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) +- Static site does not render under HTTPS [#194](https://github.com/knsv/mermaid/issues/194) +- Error on simple graph [#192](https://github.com/knsv/mermaid/issues/192) +- Escape "~" [#191](https://github.com/knsv/mermaid/issues/191) +- Trying to add link using 'click' to flowchart [#188](https://github.com/knsv/mermaid/issues/188) +- cli: no lines and arrowheads rendered / only dotted lines [#187](https://github.com/knsv/mermaid/issues/187) +- text of mermaid div displayed on page [#186](https://github.com/knsv/mermaid/issues/186) +- using mermaid with laravel [#185](https://github.com/knsv/mermaid/issues/185) +- Atom editor package [#183](https://github.com/knsv/mermaid/issues/183) +- Auto linewrap for notes in sequence diagrams [#178](https://github.com/knsv/mermaid/issues/178) +- Execute code after initialize [#176](https://github.com/knsv/mermaid/issues/176) +- Autoscaling for all diagram types [#175](https://github.com/knsv/mermaid/issues/175) +- Problem wit click event callback [#174](https://github.com/knsv/mermaid/issues/174) +- How to escape characters? [#170](https://github.com/knsv/mermaid/issues/170) +- it can not work [#167](https://github.com/knsv/mermaid/issues/167) +- Broken subgraph using the CLI [#153](https://github.com/knsv/mermaid/issues/153) +- IE Support issue [#142](https://github.com/knsv/mermaid/issues/142) +- Flowchart truncated [#140](https://github.com/knsv/mermaid/issues/140) +- Double Quote as text is not working [#219](https://github.com/knsv/mermaid/issues/219) +- classDef / class not working with htmlLabels? [#210](https://github.com/knsv/mermaid/issues/210) +- Links in graph missing [#209](https://github.com/knsv/mermaid/issues/209) +- 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) +- SVG foreignObject rendering [#180](https://github.com/knsv/mermaid/issues/180) +- 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) +- \[Parser] Hyphen in participant name bring TypeError [#74](https://github.com/knsv/mermaid/issues/74) **Merged pull requests:** -* Update flowchart.md [#214](https://github.com/knsv/mermaid/pull/214) ([orschiro](https://github.com/orschiro)) -* Default style when using the CLI [#205](https://github.com/knsv/mermaid/pull/205) ([gillesdemey](https://github.com/gillesdemey)) -* Gantt chart - add minutes and seconds durations [#198](https://github.com/knsv/mermaid/pull/198) ([dbrans](https://github.com/dbrans)) -* Using QUnit for AMD testing [#190](https://github.com/knsv/mermaid/pull/190) ([bollwyvl](https://github.com/bollwyvl)) -* Update phantomscript.js [#182](https://github.com/knsv/mermaid/pull/182) ([phairow](https://github.com/phairow)) +- Update flowchart.md [#214](https://github.com/knsv/mermaid/pull/214) ([orschiro](https://github.com/orschiro)) +- Default style when using the CLI [#205](https://github.com/knsv/mermaid/pull/205) ([gillesdemey](https://github.com/gillesdemey)) +- Gantt chart - add minutes and seconds durations [#198](https://github.com/knsv/mermaid/pull/198) ([dbrans](https://github.com/dbrans)) +- Using QUnit for AMD testing [#190](https://github.com/knsv/mermaid/pull/190) ([bollwyvl](https://github.com/bollwyvl)) +- 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) @@ -680,36 +682,36 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* To SVG Export [#146](https://github.com/knsv/mermaid/issues/146) -* Possibility to set the width of the generated flowchart [#129](https://github.com/knsv/mermaid/issues/129) -* Special characters break parsing [#54](https://github.com/knsv/mermaid/issues/54) -* Responsive graph layout for mobile viewers [#51](https://github.com/knsv/mermaid/issues/51) -* Styling connector lines [#31](https://github.com/knsv/mermaid/issues/31) +- To SVG Export [#146](https://github.com/knsv/mermaid/issues/146) +- Possibility to set the width of the generated flowchart [#129](https://github.com/knsv/mermaid/issues/129) +- Special characters break parsing [#54](https://github.com/knsv/mermaid/issues/54) +- Responsive graph layout for mobile viewers [#51](https://github.com/knsv/mermaid/issues/51) +- Styling connector lines [#31](https://github.com/knsv/mermaid/issues/31) **Fixed bugs:** -* flowchart - styling of edges via css overrides specific styles set in the graph definition [#128](https://github.com/knsv/mermaid/issues/128) +- flowchart - styling of edges via css overrides specific styles set in the graph definition [#128](https://github.com/knsv/mermaid/issues/128) **Closed issues:** -* Live editor is broken [#173](https://github.com/knsv/mermaid/issues/173) -* 0.5.0 no longer respects custom date definitions in Gantt diagrams [#171](https://github.com/knsv/mermaid/issues/171) -* Drop label character restrictions [#162](https://github.com/knsv/mermaid/issues/162) -* can't nest subgraphs in flowchart [#161](https://github.com/knsv/mermaid/issues/161) -* Unable to generate gantt diagram with mermaid CLI [#158](https://github.com/knsv/mermaid/issues/158) -* Inline css by "mermaid" [#157](https://github.com/knsv/mermaid/issues/157) -* Finite State Machine Diagram [#152](https://github.com/knsv/mermaid/issues/152) -* How to center align gantt diagram [#150](https://github.com/knsv/mermaid/issues/150) -* Security concern regarding class definition [#148](https://github.com/knsv/mermaid/issues/148) -* File Extension [#147](https://github.com/knsv/mermaid/issues/147) -* `setTimeout` with clusters problematic with programmatic edits and no callback [#133](https://github.com/knsv/mermaid/issues/133) -* module.exports.cloneCssStyles() in combination with Angularjs breaks display in Chrome and IE [#126](https://github.com/knsv/mermaid/issues/126) -* Gantt - suitable xAxis for longer project [#125](https://github.com/knsv/mermaid/issues/125) -* How to get started with this project ? [#64](https://github.com/knsv/mermaid/issues/64) +- Live editor is broken [#173](https://github.com/knsv/mermaid/issues/173) +- 0.5.0 no longer respects custom date definitions in Gantt diagrams [#171](https://github.com/knsv/mermaid/issues/171) +- Drop label character restrictions [#162](https://github.com/knsv/mermaid/issues/162) +- can't nest subgraphs in flowchart [#161](https://github.com/knsv/mermaid/issues/161) +- Unable to generate gantt diagram with mermaid CLI [#158](https://github.com/knsv/mermaid/issues/158) +- Inline css by "mermaid" [#157](https://github.com/knsv/mermaid/issues/157) +- Finite State Machine Diagram [#152](https://github.com/knsv/mermaid/issues/152) +- How to center align gantt diagram [#150](https://github.com/knsv/mermaid/issues/150) +- Security concern regarding class definition [#148](https://github.com/knsv/mermaid/issues/148) +- File Extension [#147](https://github.com/knsv/mermaid/issues/147) +- `setTimeout` with clusters problematic with programmatic edits and no callback [#133](https://github.com/knsv/mermaid/issues/133) +- module.exports.cloneCssStyles() in combination with Angularjs breaks display in Chrome and IE [#126](https://github.com/knsv/mermaid/issues/126) +- Gantt - suitable xAxis for longer project [#125](https://github.com/knsv/mermaid/issues/125) +- How to get started with this project ? [#64](https://github.com/knsv/mermaid/issues/64) **Merged pull requests:** -* 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) @@ -717,35 +719,35 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Add a css file, mermaid.css, with default styling [#122](https://github.com/knsv/mermaid/issues/122) -* software architecture diagram [#36](https://github.com/knsv/mermaid/issues/36) -* Support for bar charts and pie diagrams [#22](https://github.com/knsv/mermaid/issues/22) +- Add a css file, mermaid.css, with default styling [#122](https://github.com/knsv/mermaid/issues/122) +- software architecture diagram [#36](https://github.com/knsv/mermaid/issues/36) +- Support for bar charts and pie diagrams [#22](https://github.com/knsv/mermaid/issues/22) **Closed issues:** -* uglifyjs wanrings which means we can improve the code [#156](https://github.com/knsv/mermaid/issues/156) -* New(er) features unavailable in downloadable js files? [#151](https://github.com/knsv/mermaid/issues/151) -* Add gh-gapes link to description [#143](https://github.com/knsv/mermaid/issues/143) -* Some examples not displayed on Firefox 36.0.1 [#138](https://github.com/knsv/mermaid/issues/138) -* tags ending in a "v" don't render [#132](https://github.com/knsv/mermaid/issues/132) -* Links in flowchart [#131](https://github.com/knsv/mermaid/issues/131) -* Using the library for iOS development [#130](https://github.com/knsv/mermaid/issues/130) -* Add capability for gantt diagrams [#118](https://github.com/knsv/mermaid/issues/118) -* lower case v causes error in the parser [#108](https://github.com/knsv/mermaid/issues/108) -* Label's css conflict with boostrap's .label [#67](https://github.com/knsv/mermaid/issues/67) -* TypeError: Cannot read property 'layout' of undefined [#37](https://github.com/knsv/mermaid/issues/37) +- uglifyjs wanrings which means we can improve the code [#156](https://github.com/knsv/mermaid/issues/156) +- New(er) features unavailable in downloadable js files? [#151](https://github.com/knsv/mermaid/issues/151) +- Add gh-gapes link to description [#143](https://github.com/knsv/mermaid/issues/143) +- Some examples not displayed on Firefox 36.0.1 [#138](https://github.com/knsv/mermaid/issues/138) +- tags ending in a "v" don't render [#132](https://github.com/knsv/mermaid/issues/132) +- Links in flowchart [#131](https://github.com/knsv/mermaid/issues/131) +- Using the library for iOS development [#130](https://github.com/knsv/mermaid/issues/130) +- Add capability for gantt diagrams [#118](https://github.com/knsv/mermaid/issues/118) +- lower case v causes error in the parser [#108](https://github.com/knsv/mermaid/issues/108) +- Label's css conflict with boostrap's .label [#67](https://github.com/knsv/mermaid/issues/67) +- TypeError: Cannot read property 'layout' of undefined [#37](https://github.com/knsv/mermaid/issues/37) **Merged pull requests:** -* Dev 0.5.0 [#168](https://github.com/knsv/mermaid/pull/168) ([knsv](https://github.com/knsv)) -* Fix spacing [#164](https://github.com/knsv/mermaid/pull/164) ([rhcarvalho](https://github.com/rhcarvalho)) -* Fixing typo: "Think" -> "Thick" [#160](https://github.com/knsv/mermaid/pull/160) ([it0a](https://github.com/it0a)) -* IE, local html, cssRules access is denied [#155](https://github.com/knsv/mermaid/pull/155) ([tylerlong](https://github.com/tylerlong)) -* Add automatically generated change log file. [#139](https://github.com/knsv/mermaid/pull/139) ([skywinder](https://github.com/skywinder)) -* Adding init argument to the global API [#137](https://github.com/knsv/mermaid/pull/137) ([bollwyvl](https://github.com/bollwyvl)) -* Add description of manual calling of init [#136](https://github.com/knsv/mermaid/pull/136) ([bollwyvl](https://github.com/bollwyvl)) -* Allow other forms of node selection for init() [#135](https://github.com/knsv/mermaid/pull/135) ([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)) +- Dev 0.5.0 [#168](https://github.com/knsv/mermaid/pull/168) ([knsv](https://github.com/knsv)) +- Fix spacing [#164](https://github.com/knsv/mermaid/pull/164) ([rhcarvalho](https://github.com/rhcarvalho)) +- Fixing typo: "Think" -> "Thick" [#160](https://github.com/knsv/mermaid/pull/160) ([it0a](https://github.com/it0a)) +- IE, local html, cssRules access is denied [#155](https://github.com/knsv/mermaid/pull/155) ([tylerlong](https://github.com/tylerlong)) +- Add automatically generated change log file. [#139](https://github.com/knsv/mermaid/pull/139) ([skywinder](https://github.com/skywinder)) +- Adding init argument to the global API [#137](https://github.com/knsv/mermaid/pull/137) ([bollwyvl](https://github.com/bollwyvl)) +- Add description of manual calling of init [#136](https://github.com/knsv/mermaid/pull/136) ([bollwyvl](https://github.com/bollwyvl)) +- Allow other forms of node selection for init() [#135](https://github.com/knsv/mermaid/pull/135) ([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) @@ -753,18 +755,18 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Assymetric shapes not documented [#82](https://github.com/knsv/mermaid/issues/82) -* Improve arrows [#3](https://github.com/knsv/mermaid/issues/3) +- Assymetric shapes not documented [#82](https://github.com/knsv/mermaid/issues/82) +- Improve arrows [#3](https://github.com/knsv/mermaid/issues/3) **Fixed bugs:** -* NoModificationAllowedError [#23](https://github.com/knsv/mermaid/issues/23) +- NoModificationAllowedError [#23](https://github.com/knsv/mermaid/issues/23) **Closed issues:** -* subgraph background is black in rendered flowchart PNG via CLI [#121](https://github.com/knsv/mermaid/issues/121) -* Integrate editor at https://github.com/naseer/mermaid-webapp [#110](https://github.com/knsv/mermaid/issues/110) -* Internet Explorer Support [#99](https://github.com/knsv/mermaid/issues/99) +- subgraph background is black in rendered flowchart PNG via CLI [#121](https://github.com/knsv/mermaid/issues/121) +- Integrate editor at https://github.com/naseer/mermaid-webapp [#110](https://github.com/knsv/mermaid/issues/110) +- 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) @@ -776,30 +778,30 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Apply styling from css when using the CLI utility [#85](https://github.com/knsv/mermaid/issues/85) -* Generated SVG works poorly outside web browsers [#58](https://github.com/knsv/mermaid/issues/58) -* Generating SVG text blob for use in Node [#2](https://github.com/knsv/mermaid/issues/2) +- Apply styling from css when using the CLI utility [#85](https://github.com/knsv/mermaid/issues/85) +- Generated SVG works poorly outside web browsers [#58](https://github.com/knsv/mermaid/issues/58) +- Generating SVG text blob for use in Node [#2](https://github.com/knsv/mermaid/issues/2) **Closed issues:** -* Subgraph syntax bug? [#120](https://github.com/knsv/mermaid/issues/120) -* Live editor [#115](https://github.com/knsv/mermaid/issues/115) -* Error in "Basic Syntax" wiki page [#113](https://github.com/knsv/mermaid/issues/113) -* semicolons, anyone? [#111](https://github.com/knsv/mermaid/issues/111) -* undefined `sequenceConfig` fails [#109](https://github.com/knsv/mermaid/issues/109) -* Sequence Diagrams: Show Actors below as well [#106](https://github.com/knsv/mermaid/issues/106) -* Allow overriding sequence diagram configuration (SVG properties) [#103](https://github.com/knsv/mermaid/issues/103) -* Error when rendering A-- This is the text -- B [#102](https://github.com/knsv/mermaid/issues/102) -* Clipping in documentation [#97](https://github.com/knsv/mermaid/issues/97) -* isolate class styling to the svg container [#92](https://github.com/knsv/mermaid/issues/92) -* Make the new graph declaration more visual [#40](https://github.com/knsv/mermaid/issues/40) +- Subgraph syntax bug? [#120](https://github.com/knsv/mermaid/issues/120) +- Live editor [#115](https://github.com/knsv/mermaid/issues/115) +- Error in "Basic Syntax" wiki page [#113](https://github.com/knsv/mermaid/issues/113) +- semicolons, anyone? [#111](https://github.com/knsv/mermaid/issues/111) +- undefined `sequenceConfig` fails [#109](https://github.com/knsv/mermaid/issues/109) +- Sequence Diagrams: Show Actors below as well [#106](https://github.com/knsv/mermaid/issues/106) +- Allow overriding sequence diagram configuration (SVG properties) [#103](https://github.com/knsv/mermaid/issues/103) +- Error when rendering A-- This is the text -- B [#102](https://github.com/knsv/mermaid/issues/102) +- Clipping in documentation [#97](https://github.com/knsv/mermaid/issues/97) +- isolate class styling to the svg container [#92](https://github.com/knsv/mermaid/issues/92) +- Make the new graph declaration more visual [#40](https://github.com/knsv/mermaid/issues/40) **Merged pull requests:** -* Add live editor [#119](https://github.com/knsv/mermaid/pull/119) ([naseer](https://github.com/naseer)) -* Adds CSS option to the CLI [#116](https://github.com/knsv/mermaid/pull/116) ([fardog](https://github.com/fardog)) -* Update flowchart.md in response Issue #113 [#114](https://github.com/knsv/mermaid/pull/114) ([vijay40](https://github.com/vijay40)) -* 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)) +- Add live editor [#119](https://github.com/knsv/mermaid/pull/119) ([naseer](https://github.com/naseer)) +- Adds CSS option to the CLI [#116](https://github.com/knsv/mermaid/pull/116) ([fardog](https://github.com/fardog)) +- Update flowchart.md in response Issue #113 [#114](https://github.com/knsv/mermaid/pull/114) ([vijay40](https://github.com/vijay40)) +- 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) @@ -807,20 +809,20 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Support for dotted links [#26](https://github.com/knsv/mermaid/issues/26) +- Support for dotted links [#26](https://github.com/knsv/mermaid/issues/26) **Closed issues:** -* Missing arrows in sequence diagram [#98](https://github.com/knsv/mermaid/issues/98) -* Error with >9 linkStyles [#95](https://github.com/knsv/mermaid/issues/95) +- Missing arrows in sequence diagram [#98](https://github.com/knsv/mermaid/issues/98) +- Error with >9 linkStyles [#95](https://github.com/knsv/mermaid/issues/95) **Merged pull requests:** -* Require d3 directly to better support Node usage [#107](https://github.com/knsv/mermaid/pull/107) ([markdalgleish](https://github.com/markdalgleish)) -* update doc with -c option [#105](https://github.com/knsv/mermaid/pull/105) ([jjmr](https://github.com/jjmr)) -* Add new parameter to the console client to override the svg configuration in sequence diagrams [#104](https://github.com/knsv/mermaid/pull/104) ([jjmr](https://github.com/jjmr)) -* Text based labels, new shape [#101](https://github.com/knsv/mermaid/pull/101) ([bjowes](https://github.com/bjowes)) -* fix html tags in example usage [#100](https://github.com/knsv/mermaid/pull/100) ([deiwin](https://github.com/deiwin)) +- Require d3 directly to better support Node usage [#107](https://github.com/knsv/mermaid/pull/107) ([markdalgleish](https://github.com/markdalgleish)) +- update doc with -c option [#105](https://github.com/knsv/mermaid/pull/105) ([jjmr](https://github.com/jjmr)) +- Add new parameter to the console client to override the svg configuration in sequence diagrams [#104](https://github.com/knsv/mermaid/pull/104) ([jjmr](https://github.com/jjmr)) +- Text based labels, new shape [#101](https://github.com/knsv/mermaid/pull/101) ([bjowes](https://github.com/bjowes)) +- 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) @@ -828,22 +830,22 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Make link text look like it is on the line [#53](https://github.com/knsv/mermaid/issues/53) +- Make link text look like it is on the line [#53](https://github.com/knsv/mermaid/issues/53) **Closed issues:** -* disable auto render [#91](https://github.com/knsv/mermaid/issues/91) -* Tidy breaks mermaid (linebreaks in \
) [#87](https://github.com/knsv/mermaid/issues/87) -* Bug: \
being rendered as text in node [#73](https://github.com/knsv/mermaid/issues/73) -* Graph edges appear to render outside of the canvas [#70](https://github.com/knsv/mermaid/issues/70) +- disable auto render [#91](https://github.com/knsv/mermaid/issues/91) +- Tidy breaks mermaid (linebreaks in \
) [#87](https://github.com/knsv/mermaid/issues/87) +- Bug: \
being rendered as text in node [#73](https://github.com/knsv/mermaid/issues/73) +- Graph edges appear to render outside of the canvas [#70](https://github.com/knsv/mermaid/issues/70) **Merged pull requests:** -* Merge pull request #1 from knsv/master [#96](https://github.com/knsv/mermaid/pull/96) ([gkchic](https://github.com/gkchic)) -* Removed duplicated section in flowchart docs [#94](https://github.com/knsv/mermaid/pull/94) ([kaime](https://github.com/kaime)) -* Grammar changes to sequence page [#93](https://github.com/knsv/mermaid/pull/93) ([gkchic](https://github.com/gkchic)) -* Github buttons [#89](https://github.com/knsv/mermaid/pull/89) ([gkchic](https://github.com/gkchic)) -* Template change [#88](https://github.com/knsv/mermaid/pull/88) ([gkchic](https://github.com/gkchic)) +- Merge pull request #1 from knsv/master [#96](https://github.com/knsv/mermaid/pull/96) ([gkchic](https://github.com/gkchic)) +- Removed duplicated section in flowchart docs [#94](https://github.com/knsv/mermaid/pull/94) ([kaime](https://github.com/kaime)) +- Grammar changes to sequence page [#93](https://github.com/knsv/mermaid/pull/93) ([gkchic](https://github.com/gkchic)) +- Github buttons [#89](https://github.com/knsv/mermaid/pull/89) ([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) @@ -851,22 +853,22 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Support for sequence diagrams [#16](https://github.com/knsv/mermaid/issues/16) -* Client utility for mermaid [#6](https://github.com/knsv/mermaid/issues/6) +- Support for sequence diagrams [#16](https://github.com/knsv/mermaid/issues/16) +- Client utility for mermaid [#6](https://github.com/knsv/mermaid/issues/6) **Closed issues:** -* Non ASCII chars in labels [#84](https://github.com/knsv/mermaid/issues/84) -* 'undefined' titles of Quicklinks on the usage page [#80](https://github.com/knsv/mermaid/issues/80) -* \[cli] Enhancement proposal: not fail --version / --help if phantomjs isn't installed [#71](https://github.com/knsv/mermaid/issues/71) +- Non ASCII chars in labels [#84](https://github.com/knsv/mermaid/issues/84) +- 'undefined' titles of Quicklinks on the usage page [#80](https://github.com/knsv/mermaid/issues/80) +- \[cli] Enhancement proposal: not fail --version / --help if phantomjs isn't installed [#71](https://github.com/knsv/mermaid/issues/71) **Merged pull requests:** -* Flowchart doc: Text in the circle now in a circle [#81](https://github.com/knsv/mermaid/pull/81) ([Grahack](https://github.com/Grahack)) -* Fix for issue #73 [#79](https://github.com/knsv/mermaid/pull/79) ([it0a](https://github.com/it0a)) -* Ink template [#78](https://github.com/knsv/mermaid/pull/78) ([gkchic](https://github.com/gkchic)) -* Show help and version even if phantom isn't present. Fixes #71 [#75](https://github.com/knsv/mermaid/pull/75) ([fardog](https://github.com/fardog)) -* Add apostrophe & 'and' [#72](https://github.com/knsv/mermaid/pull/72) ([sudodoki](https://github.com/sudodoki)) +- Flowchart doc: Text in the circle now in a circle [#81](https://github.com/knsv/mermaid/pull/81) ([Grahack](https://github.com/Grahack)) +- Fix for issue #73 [#79](https://github.com/knsv/mermaid/pull/79) ([it0a](https://github.com/it0a)) +- Ink template [#78](https://github.com/knsv/mermaid/pull/78) ([gkchic](https://github.com/gkchic)) +- Show help and version even if phantom isn't present. Fixes #71 [#75](https://github.com/knsv/mermaid/pull/75) ([fardog](https://github.com/fardog)) +- 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) @@ -874,22 +876,22 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* How do I do comments? [#47](https://github.com/knsv/mermaid/issues/47) -* Improve readability with new line as terminator and whitespace [#38](https://github.com/knsv/mermaid/issues/38) +- How do I do comments? [#47](https://github.com/knsv/mermaid/issues/47) +- Improve readability with new line as terminator and whitespace [#38](https://github.com/knsv/mermaid/issues/38) **Fixed bugs:** -* This characters failed the lexical parsing [#46](https://github.com/knsv/mermaid/issues/46) +- This characters failed the lexical parsing [#46](https://github.com/knsv/mermaid/issues/46) **Closed issues:** -* Trailing whitespace at the end of lines is not ignored [#55](https://github.com/knsv/mermaid/issues/55) -* Use classes instead of inline style for easy styling [#24](https://github.com/knsv/mermaid/issues/24) +- Trailing whitespace at the end of lines is not ignored [#55](https://github.com/knsv/mermaid/issues/55) +- Use classes instead of inline style for easy styling [#24](https://github.com/knsv/mermaid/issues/24) **Merged pull requests:** -* Adds Command Line Interface for generating PNGs from mermaid description files [#69](https://github.com/knsv/mermaid/pull/69) ([fardog](https://github.com/fardog)) -* Allow special symbols for direction along with acronyms [#66](https://github.com/knsv/mermaid/pull/66) ([vijay40](https://github.com/vijay40)) +- Adds Command Line Interface for generating PNGs from mermaid description files [#69](https://github.com/knsv/mermaid/pull/69) ([fardog](https://github.com/fardog)) +- 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) @@ -897,25 +899,25 @@ By doing this clicks and tags are again allowed. **Fixed bugs:** -* Lines routed outside visible area [#19](https://github.com/knsv/mermaid/issues/19) +- Lines routed outside visible area [#19](https://github.com/knsv/mermaid/issues/19) **Closed issues:** -* Mermaid not rendering properly on Wordpress pages [#59](https://github.com/knsv/mermaid/issues/59) -* Improve example page with live demo [#52](https://github.com/knsv/mermaid/issues/52) -* Does not render upon AngularJS Updates [#45](https://github.com/knsv/mermaid/issues/45) -* Download link in README.MD doesn't work. [#42](https://github.com/knsv/mermaid/issues/42) -* linkStyle usage is not obvious [#41](https://github.com/knsv/mermaid/issues/41) -* Move \*.spec.js in src/ to test/ [#35](https://github.com/knsv/mermaid/issues/35) +- Mermaid not rendering properly on Wordpress pages [#59](https://github.com/knsv/mermaid/issues/59) +- Improve example page with live demo [#52](https://github.com/knsv/mermaid/issues/52) +- Does not render upon AngularJS Updates [#45](https://github.com/knsv/mermaid/issues/45) +- Download link in README.MD doesn't work. [#42](https://github.com/knsv/mermaid/issues/42) +- linkStyle usage is not obvious [#41](https://github.com/knsv/mermaid/issues/41) +- Move \*.spec.js in src/ to test/ [#35](https://github.com/knsv/mermaid/issues/35) **Merged pull requests:** -* 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)) -* 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)) -* 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)) +- 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)) +- 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)) +- 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)) ## [0.2.15](https://github.com/knsv/mermaid/tree/0.2.15) (2014-12-05) @@ -923,19 +925,19 @@ By doing this clicks and tags are again allowed. **Fixed bugs:** -* Error with some characters [#25](https://github.com/knsv/mermaid/issues/25) -* Cap-cased words break parser [#8](https://github.com/knsv/mermaid/issues/8) +- Error with some characters [#25](https://github.com/knsv/mermaid/issues/25) +- Cap-cased words break parser [#8](https://github.com/knsv/mermaid/issues/8) **Closed issues:** -* Question marks don't render properly with /dist/mermaid.full.min.js [#30](https://github.com/knsv/mermaid/issues/30) -* Provide parse function in browser widthout `require`? [#21](https://github.com/knsv/mermaid/issues/21) -* Better label text support [#18](https://github.com/knsv/mermaid/issues/18) +- Question marks don't render properly with /dist/mermaid.full.min.js [#30](https://github.com/knsv/mermaid/issues/30) +- Provide parse function in browser widthout `require`? [#21](https://github.com/knsv/mermaid/issues/21) +- Better label text support [#18](https://github.com/knsv/mermaid/issues/18) **Merged pull requests:** -* 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)) +- 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)) ## [0.2.14](https://github.com/knsv/mermaid/tree/0.2.14) (2014-12-03) @@ -947,14 +949,14 @@ By doing this clicks and tags are again allowed. **Implemented enhancements:** -* Publish to NPM [#7](https://github.com/knsv/mermaid/issues/7) +- Publish to NPM [#7](https://github.com/knsv/mermaid/issues/7) **Closed issues:** -* modified init to be applied more than once [#29](https://github.com/knsv/mermaid/issues/29) -* Wanted to know build process for the project. [#28](https://github.com/knsv/mermaid/issues/28) -* can not support Chinese description [#20](https://github.com/knsv/mermaid/issues/20) -* Support unicode chars in labels [#9](https://github.com/knsv/mermaid/issues/9) +- modified init to be applied more than once [#29](https://github.com/knsv/mermaid/issues/29) +- Wanted to know build process for the project. [#28](https://github.com/knsv/mermaid/issues/28) +- can not support Chinese description [#20](https://github.com/knsv/mermaid/issues/20) +- 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) @@ -966,12 +968,12 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* Add link to jsbin playground to README [#11](https://github.com/knsv/mermaid/issues/11) -* What are the requirements ? [#10](https://github.com/knsv/mermaid/issues/10) +- Add link to jsbin playground to README [#11](https://github.com/knsv/mermaid/issues/11) +- What are the requirements ? [#10](https://github.com/knsv/mermaid/issues/10) **Merged pull requests:** -* 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) @@ -983,7 +985,7 @@ By doing this clicks and tags are again allowed. **Closed issues:** -* 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) @@ -995,7 +997,7 @@ By doing this clicks and tags are again allowed. **Merged pull requests:** -* 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) diff --git a/docs/Configuration.md b/docs/Configuration.md index 2d1f52690..9c95f5137 100644 --- a/docs/Configuration.md +++ b/docs/Configuration.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Configuration Configuration is the second half of Mermaid, after deployment. Together Deployment and Configuration constitute the whole of Mermaid. diff --git a/docs/README.md b/docs/README.md index 705c08c4f..9fad3bcdf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # About Mermaid **Mermaid lets you create diagrams and visualizations using text and code.** @@ -9,7 +10,7 @@ It is a JavaScript based diagramming and charting tool that renders Markdown-ins -[![Build Status](https://travis-ci.org/mermaid-js/mermaid.svg?branch=master)](https://travis-ci.org/mermaid-js/mermaid) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat\&color=9cf\&logo=slack\&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) +[![Build Status](https://travis-ci.org/mermaid-js/mermaid.svg?branch=master)](https://travis-ci.org/mermaid-js/mermaid) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE) @@ -213,10 +214,10 @@ To Deploy Mermaid: ## Sibling projects -* [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) -* [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) -* [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) -* [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) +- [Mermaid Live Editor](https://github.com/mermaid-js/mermaid-live-editor) +- [Mermaid CLI](https://github.com/mermaid-js/mermaid-cli) +- [Mermaid Webpack Demo](https://github.com/mermaidjs/mermaid-webpack-demo) +- [Mermaid Parcel Demo](https://github.com/mermaidjs/mermaid-parcel-demo) ## Request for Assistance @@ -228,8 +229,8 @@ represent the project when answering questions and issues. Together we could continue the work with things like: -* Adding more types of diagrams like mindmaps, ert diagrams, etc. -* Improving existing diagrams +- Adding more types of diagrams like mindmaps, ert diagrams, etc. +- Improving existing diagrams Don't hesitate to contact me if you want to get involved! @@ -278,9 +279,9 @@ The above command generates files into the `dist` folder and publishes them to n ## Related projects -* [Command Line Interface](https://github.com/mermaid-js/mermaid-cli) -* [Live Editor](https://github.com/mermaid-js/mermaid-live-editor) -* [HTTP Server](https://github.com/TomWright/mermaid-server) +- [Command Line Interface](https://github.com/mermaid-js/mermaid-cli) +- [Live Editor](https://github.com/mermaid-js/mermaid-live-editor) +- [HTTP Server](https://github.com/TomWright/mermaid-server) ## Contributors [![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) @@ -294,7 +295,7 @@ For public sites, it can be precarious to retrieve text from users on the intern As an extra level of security for sites with external users we are happy to introduce a new security level in which the diagram is rendered in a sandboxed iframe preventing JavaScript in the code from being executed. This is a great step forward for better security. -*Unfortunately you can not have a cake and eat it at the same time which in this case means that some of the interactive functionality gets blocked along with the possible malicious code.* +_Unfortunately you can not have a cake and eat it at the same time which in this case means that some of the interactive functionality gets blocked along with the possible malicious code._ ## Reporting vulnerabilities @@ -304,10 +305,10 @@ To report a vulnerability, please e-mail security@mermaid.live with a descriptio A quick note from Knut Sveidqvist: -> *Many thanks to the [d3](https://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!* >*Thanks also to the [js-sequence-diagram](https://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering.* >*Thank you to [Tyler Long](https://github.com/tylerlong) who has been a collaborator since April 2017.* +> _Many thanks to the [d3](https://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!_ >_Thanks also to the [js-sequence-diagram](https://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering._ >_Thank you to [Tyler Long](https://github.com/tylerlong) who has been a collaborator since April 2017._ > -> *Thank you to the ever-growing list of [contributors](https://github.com/knsv/mermaid/graphs/contributors) that brought the project this far!* +> _Thank you to the ever-growing list of [contributors](https://github.com/knsv/mermaid/graphs/contributors) that brought the project this far!_ -*** +--- -*Mermaid was created by Knut Sveidqvist for easier documentation.* +_Mermaid was created by Knut Sveidqvist for easier documentation._ diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index eb8bd0d08..d099a5767 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,16 +1,17 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Summary -* [mermaid](README.md) -* [FAQ](faq.md) -* [Breaking changes](breakingChanges.md) -* [Usage](usage.md) -* [Flowchart](flowchart.md) -* [Sequence diagram](sequenceDiagram.md) -* [Gantt diagram](gantt.md) -* [mermaid CLI](mermaidCLI.md) -* [Demos](demos.md) -* [mermaidAPI](mermaidAPI.md) -* [Development](development.md) -* [Upgrading](upgrading.md) -* [Contribute to this website](https://github.com/mermaidjs/mermaid-gitbook) +- [mermaid](README.md) +- [FAQ](faq.md) +- [Breaking changes](breakingChanges.md) +- [Usage](usage.md) +- [Flowchart](flowchart.md) +- [Sequence diagram](sequenceDiagram.md) +- [Gantt diagram](gantt.md) +- [mermaid CLI](mermaidCLI.md) +- [Demos](demos.md) +- [mermaidAPI](mermaidAPI.md) +- [Development](development.md) +- [Upgrading](upgrading.md) +- [Contribute to this website](https://github.com/mermaidjs/mermaid-gitbook) diff --git a/docs/Setup.md b/docs/Setup.md index 8a1e89e0e..161ea353a 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + ## mermaidAPI @@ -59,18 +60,18 @@ Theme , the CSS style sheet ## logLevel -| Parameter | Description | Type | Required | Values | -| --------- | ----------------------------------------------------- | ---------------- | -------- | --------------------------------------------- | -| logLevel | This option decides the amount of logging to be used. | string | number | Required | 'trace','debug','info','warn','error','fatal' | +| Parameter | Description | Type | Required | Values | +| --------- | ----------------------------------------------------- | ------ | -------- | -------- | --------------------------------------------- | +| logLevel | This option decides the amount of logging to be used. | string | number | Required | 'trace','debug','info','warn','error','fatal' | **Notes:** -* Trace: 0 -* Debug: 1 -* Info: 2 -* Warn: 3 -* Error: 4 -* Fatal: 5 (default) +- Trace: 0 +- Debug: 1 +- Info: 2 +- Warn: 3 +- Error: 4 +- Fatal: 5 (default) ## securityLevel @@ -80,11 +81,11 @@ Theme , the CSS style sheet **Notes**: -* **strict**: (**default**) tags in text are encoded, click functionality is disabled -* **loose**: tags in text are allowed, click functionality is enabled -* **antiscript**: html tags in text are allowed, (only script element is removed), click +- **strict**: (**default**) tags in text are encoded, click functionality is disabled +- **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 -* **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 of the diagram like scripts, popups in sequence diagram or links to other tabs/targets etc. @@ -110,7 +111,7 @@ Default value: false ## secure -This option controls which currentConfig keys are considered *secure* and can only be changed +This option controls which currentConfig keys are considered _secure_ and can only be changed via call to mermaidAPI.initialize. Calls to mermaidAPI.reinitialize cannot make changes to the `secure` keys in the current currentConfig. This prevents malicious graph directives from overriding a site's default security. @@ -1016,19 +1017,19 @@ This sets the font weight of Person shape for the diagram **Notes:** Default value: normal. -### external\_personFontSize +### external_personFontSize This sets the font size of External Person shape for the diagram **Notes:** Default value: 14. -### external\_personFontFamily +### external_personFontFamily This sets the font family of External Person shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_personFontWeight +### external_personFontWeight This sets the font weight of External Person shape for the diagram @@ -1052,91 +1053,91 @@ This sets the font weight of System shape for the diagram **Notes:** Default value: normal. -### external\_systemFontSize +### external_systemFontSize This sets the font size of External System shape for the diagram **Notes:** Default value: 14. -### external\_systemFontFamily +### external_systemFontFamily This sets the font family of External System shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_systemFontWeight +### external_systemFontWeight This sets the font weight of External System shape for the diagram **Notes:** Default value: normal. -### system\_dbFontSize +### system_dbFontSize This sets the font size of System DB shape for the diagram **Notes:** Default value: 14. -### system\_dbFontFamily +### system_dbFontFamily This sets the font family of System DB shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### system\_dbFontWeight +### system_dbFontWeight This sets the font weight of System DB shape for the diagram **Notes:** Default value: normal. -### external\_system\_dbFontSize +### external_system_dbFontSize This sets the font size of External System DB shape for the diagram **Notes:** Default value: 14. -### external\_system\_dbFontFamily +### external_system_dbFontFamily This sets the font family of External System DB shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_system\_dbFontWeight +### external_system_dbFontWeight This sets the font weight of External System DB shape for the diagram **Notes:** Default value: normal. -### system\_queueFontSize +### system_queueFontSize This sets the font size of System Queue shape for the diagram **Notes:** Default value: 14. -### system\_queueFontFamily +### system_queueFontFamily This sets the font family of System Queue shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### system\_queueFontWeight +### system_queueFontWeight This sets the font weight of System Queue shape for the diagram **Notes:** Default value: normal. -### external\_system\_queueFontSize +### external_system_queueFontSize This sets the font size of External System Queue shape for the diagram **Notes:** Default value: 14. -### external\_system\_queueFontFamily +### external_system_queueFontFamily This sets the font family of External System Queue shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_system\_queueFontWeight +### external_system_queueFontWeight This sets the font weight of External System Queue shape for the diagram @@ -1196,91 +1197,91 @@ This sets the font weight of Container shape for the diagram **Notes:** Default value: normal. -### external\_containerFontSize +### external_containerFontSize This sets the font size of External Container shape for the diagram **Notes:** Default value: 14. -### external\_containerFontFamily +### external_containerFontFamily This sets the font family of External Container shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_containerFontWeight +### external_containerFontWeight This sets the font weight of External Container shape for the diagram **Notes:** Default value: normal. -### container\_dbFontSize +### container_dbFontSize This sets the font size of Container DB shape for the diagram **Notes:** Default value: 14. -### container\_dbFontFamily +### container_dbFontFamily This sets the font family of Container DB shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### container\_dbFontWeight +### container_dbFontWeight This sets the font weight of Container DB shape for the diagram **Notes:** Default value: normal. -### external\_container\_dbFontSize +### external_container_dbFontSize This sets the font size of External Container DB shape for the diagram **Notes:** Default value: 14. -### external\_container\_dbFontFamily +### external_container_dbFontFamily This sets the font family of External Container DB shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_container\_dbFontWeight +### external_container_dbFontWeight This sets the font weight of External Container DB shape for the diagram **Notes:** Default value: normal. -### container\_queueFontSize +### container_queueFontSize This sets the font size of Container Queue shape for the diagram **Notes:** Default value: 14. -### container\_queueFontFamily +### container_queueFontFamily This sets the font family of Container Queue shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### container\_queueFontWeight +### container_queueFontWeight This sets the font weight of Container Queue shape for the diagram **Notes:** Default value: normal. -### external\_container\_queueFontSize +### external_container_queueFontSize This sets the font size of External Container Queue shape for the diagram **Notes:** Default value: 14. -### external\_container\_queueFontFamily +### external_container_queueFontFamily This sets the font family of External Container Queue shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_container\_queueFontWeight +### external_container_queueFontWeight This sets the font weight of External Container Queue shape for the diagram @@ -1304,91 +1305,91 @@ This sets the font weight of Component shape for the diagram **Notes:** Default value: normal. -### external\_componentFontSize +### external_componentFontSize This sets the font size of External Component shape for the diagram **Notes:** Default value: 14. -### external\_componentFontFamily +### external_componentFontFamily This sets the font family of External Component shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_componentFontWeight +### external_componentFontWeight This sets the font weight of External Component shape for the diagram **Notes:** Default value: normal. -### component\_dbFontSize +### component_dbFontSize This sets the font size of Component DB shape for the diagram **Notes:** Default value: 14. -### component\_dbFontFamily +### component_dbFontFamily This sets the font family of Component DB shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### component\_dbFontWeight +### component_dbFontWeight This sets the font weight of Component DB shape for the diagram **Notes:** Default value: normal. -### external\_component\_dbFontSize +### external_component_dbFontSize This sets the font size of External Component DB shape for the diagram **Notes:** Default value: 14. -### external\_component\_dbFontFamily +### external_component_dbFontFamily This sets the font family of External Component DB shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_component\_dbFontWeight +### external_component_dbFontWeight This sets the font weight of External Component DB shape for the diagram **Notes:** Default value: normal. -### component\_queueFontSize +### component_queueFontSize This sets the font size of Component Queue shape for the diagram **Notes:** Default value: 14. -### component\_queueFontFamily +### component_queueFontFamily This sets the font family of Component Queue shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### component\_queueFontWeight +### component_queueFontWeight This sets the font weight of Component Queue shape for the diagram **Notes:** Default value: normal. -### external\_component\_queueFontSize +### external_component_queueFontSize This sets the font size of External Component Queue shape for the diagram **Notes:** Default value: 14. -### external\_component\_queueFontFamily +### external_component_queueFontFamily This sets the font family of External Component Queue shape for the diagram **Notes:** Default value: "Open Sans", sans-serif. -### external\_component\_queueFontWeight +### external_component_queueFontWeight This sets the font weight of External Component Queue shape for the diagram @@ -1417,11 +1418,11 @@ This sets the auto-wrap padding for the diagram (sides only) **Notes:** Sets the siteConfig. The siteConfig is a protected configuration for repeat use. Calls to reset() will reset the currentConfig to siteConfig. Calls to reset(configApi.defaultConfig) will reset siteConfig and currentConfig to the defaultConfig Note: currentConfig is set in this -function *Default value: At default, will mirror Global Config* +function _Default value: At default, will mirror Global Config_ ### Parameters -* `conf` **MermaidConfig** The base currentConfig to use as siteConfig +- `conf` **MermaidConfig** The base currentConfig to use as siteConfig Returns **[object][5]** The siteConfig @@ -1451,7 +1452,7 @@ corresponding siteConfig value. ### Parameters -* `conf` **any** The potential currentConfig +- `conf` **any** The potential currentConfig Returns **any** The currentConfig merged with the sanitized conf @@ -1461,23 +1462,23 @@ Function that renders an svg with a graph from a chart definition. Usage example ```javascript mermaidAPI.initialize({ - startOnLoad: true, + startOnLoad: true, }); $(function () { - const graphDefinition = 'graph TB\na-->b'; - const cb = function (svgGraph) { - console.log(svgGraph); - }; - mermaidAPI.render('id1', graphDefinition, cb); + const graphDefinition = 'graph TB\na-->b'; + const cb = function (svgGraph) { + console.log(svgGraph); + }; + mermaidAPI.render('id1', graphDefinition, cb); }); ``` ### Parameters -* `id` **[string][6]** The id of the element to be rendered -* `text` **[string][6]** The graph definition -* `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 +- `id` **[string][6]** The id of the element to be rendered +- `text` **[string][6]** The graph definition +- `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 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. @@ -1508,7 +1509,7 @@ options in-place ### Parameters -* `options` **any** The potential setConfig parameter +- `options` **any** The potential setConfig parameter ## addDirective @@ -1516,7 +1517,7 @@ Pushes in a directive to the configuration ### Parameters -* `directive` **[object][5]** The directive to push in +- `directive` **[object][5]** The directive to push in ## reset @@ -1536,7 +1537,7 @@ Pushes in a directive to the configuration ### Parameters -* `config` (optional, default `siteConfig`) +- `config` (optional, default `siteConfig`) Returns **void** @@ -1544,7 +1545,7 @@ Returns **void** ### Parameters -* `options` **MermaidConfig** +- `options` **MermaidConfig** ## @@ -1552,74 +1553,68 @@ Returns **void** ```html ``` [1]: https://github.com/mermaid-js/mermaid/blob/develop/src/mermaidAPI.js - [2]: Setup.md?id=render - [3]: 8.6.0_docs.md - [4]: #mermaidapi-configuration-defaults - [5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object - [6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String - [7]: https://developer.mozilla.org/docs/Web/API/Element diff --git a/docs/Tutorials.md b/docs/Tutorials.md index cea7c7cb0..0211d35d0 100644 --- a/docs/Tutorials.md +++ b/docs/Tutorials.md @@ -1,7 +1,8 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # 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.** @@ -13,11 +14,11 @@ The definitions that can be generated the Live-Editor are also backwards-compati [Chris Chinchilla: Hands on - Text-based diagrams with Mermaid](https://www.youtube.com/watch?v=4_LdV1cs2sA) -[GitLab Unfiltered: How to Create Mermaid Diagrams](https://www.youtube.com/watch?v=SQ9QmuTHuSI\&t=438s) +[GitLab Unfiltered: How to Create Mermaid Diagrams](https://www.youtube.com/watch?v=SQ9QmuTHuSI&t=438s) [GitLab Unfiltered: Emilie adds a mermaid diagram to the handbook](https://www.youtube.com/watch?v=5RQqht3NNSE) -[World of Zero: I Learn How To Build Flowcharts and Signal Diagram's in Mermaid.JS](https://www.youtube.com/watch?v=7_2IroEs6Is\&t=207s) +[World of Zero: I Learn How To Build Flowcharts and Signal Diagram's in Mermaid.JS](https://www.youtube.com/watch?v=7_2IroEs6Is&t=207s) [Eddie Jaoude: Can you code your diagrams?](https://www.youtube.com/watch?v=9HZzKkAqrX8) diff --git a/docs/_navbar.md b/docs/_navbar.md index f9b570bfc..dacfc23ca 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -1,14 +1,15 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. -* Getting started - * [Quick start](quickstart.md) - * [Writing more pages](more-pages.md) - * [Custom navbar](custom-navbar.md) - * [Cover page](cover.md) +- Getting started -* Configuration - * [Configuration](configuration.md) - * [Themes](themes.md) - * [Using plugins](plugins.md) - * [Markdown configuration](markdown.md) - * [Language highlight](language-highlight.md) + - [Quick start](quickstart.md) + - [Writing more pages](more-pages.md) + - [Custom navbar](custom-navbar.md) + - [Cover page](cover.md) + +- Configuration + - [Configuration](configuration.md) + - [Themes](themes.md) + - [Using plugins](plugins.md) + - [Markdown configuration](markdown.md) + - [Language highlight](language-highlight.md) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index bc2ad8bc6..3d520f773 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,42 +1,45 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. -* 📔 Introduction - * [About Mermaid](README.md) - * [Deployment](n00b-gettingStarted.md) - * [Syntax and Configuration](n00b-syntaxReference.md) +- 📔 Introduction -* 📊 Diagram Syntax - * [Flowchart](flowchart.md) - * [Sequence Diagram](sequenceDiagram.md) - * [Class Diagram](classDiagram.md) - * [State Diagram](stateDiagram.md) - * [Entity Relationship Diagram](entityRelationshipDiagram.md) - * [User Journey](user-journey.md) - * [Gantt](gantt.md) - * [Pie Chart](pie.md) - * [Requirement Diagram](requirementDiagram.md) - * [Gitgraph (Git) Diagram 🔥](gitgraph.md) - * [C4C Diagram (Context) Diagram 🦺⚠️](c4c.md) - * [Other Examples](examples.md) + - [About Mermaid](README.md) + - [Deployment](n00b-gettingStarted.md) + - [Syntax and Configuration](n00b-syntaxReference.md) -* ⚙️ Deployment and Configuration +- 📊 Diagram Syntax - * [Tutorials](Tutorials.md) - * [API-Usage](usage.md) - * [Mermaid API Configuration](Setup.md) - * [Directives](directives.md) - * [Theming](theming.md) - * [Accessibility](accessibility.md) - * [Mermaid CLI](mermaidCLI.md) - * [Advanced usage](n00b-advanced.md) + - [Flowchart](flowchart.md) + - [Sequence Diagram](sequenceDiagram.md) + - [Class Diagram](classDiagram.md) + - [State Diagram](stateDiagram.md) + - [Entity Relationship Diagram](entityRelationshipDiagram.md) + - [User Journey](user-journey.md) + - [Gantt](gantt.md) + - [Pie Chart](pie.md) + - [Requirement Diagram](requirementDiagram.md) + - [Gitgraph (Git) Diagram 🔥](gitgraph.md) + - [C4C Diagram (Context) Diagram 🦺⚠️](c4c.md) + - [Other Examples](examples.md) -* 📚 Misc - * [Use-Cases and Integrations](integrations.md) - * [FAQ](faq.md) +- ⚙️ Deployment and Configuration -* 🙌 Contributions and Community - * [Overview for Beginners](n00b-overview.md) - * [Development and Contribution ](development.md) - * [Changelog](CHANGELOG.md) - * [Adding Diagrams ](newDiagram.md) - * [Security ](security.md) + - [Tutorials](Tutorials.md) + - [API-Usage](usage.md) + - [Mermaid API Configuration](Setup.md) + - [Directives](directives.md) + - [Theming](theming.md) + - [Accessibility](accessibility.md) + - [Mermaid CLI](mermaidCLI.md) + - [Advanced usage](n00b-advanced.md) + +- 📚 Misc + + - [Use-Cases and Integrations](integrations.md) + - [FAQ](faq.md) + +- 🙌 Contributions and Community + - [Overview for Beginners](n00b-overview.md) + - [Development and Contribution ](development.md) + - [Changelog](CHANGELOG.md) + - [Adding Diagrams ](newDiagram.md) + - [Security ](security.md) diff --git a/docs/accessibility.md b/docs/accessibility.md index 6b5ccdf04..04ae64ba8 100644 --- a/docs/accessibility.md +++ b/docs/accessibility.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Accessibility Options ## Accessibility @@ -15,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: -* `accTitle: "Your Accessibility Title"` or -* `accDescr: "Your Accessibility Description"` +- `accTitle: "Your Accessibility Title"` or +- `accDescr: "Your Accessibility Description"` **When these two options are defined, they will add a coressponding `` and `<desc>` tag in the SVG.** @@ -50,11 +51,11 @@ See in the code snippet above, the `accTitle` and `accDescr` are defined in the You can also define the accessibility options in a multi-line format, where the keyword is followed by opening curly bracket `{` and then multiple lines, followed by a closing `}`. -`accTitle: My single line title value` (***single line format***) +`accTitle: My single line title value` (**_single line format_**) vs -`accDescr: { My multi-line description of the diagram }` (***multi-line format***) +`accDescr: { My multi-line description of the diagram }` (**_multi-line format_**) Let us look at it in the following example, with same flowchart: diff --git a/docs/breakingChanges.md b/docs/breakingChanges.md index c259e1783..7ea518c2b 100644 --- a/docs/breakingChanges.md +++ b/docs/breakingChanges.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Breaking changes ### Breaking changes from history version to latest version: @@ -28,13 +29,13 @@ mermaid.initialize({ In old versions you needed to reference a CSS file in your HTML: ```html -<link rel="stylesheet" href="mermaid.min.css"> +<link rel="stylesheet" href="mermaid.min.css" /> ``` or ```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. @@ -43,8 +44,8 @@ You just: ```javascript 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. diff --git a/docs/c4c.md b/docs/c4c.md index d7b835f5a..d3d4fe74b 100644 --- a/docs/c4c.md +++ b/docs/c4c.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # C4 Diagrams > C4 Diagram: This is an experimental diagram for now. The syntax and properties can change in future releases. Proper documentation will be provided when the syntax is stable. @@ -103,11 +104,11 @@ For an example, see the source code demos/index.html 5 types of C4 charts are supported. -* System Context (C4Context) -* Container diagram (C4Container) -* Component diagram (C4Component) -* Dynamic diagram (C4Dynamic) -* Deployment diagram (C4Deployment) +- System Context (C4Context) +- Container diagram (C4Container) +- Component diagram (C4Component) +- Dynamic diagram (C4Dynamic) +- 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. @@ -117,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 number of shapes per row and the number of boundaries can be adjusted using UpdateLayoutConfig. -* Layout -* * Lay\_U, Lay\_Up -* * Lay\_D, Lay\_Down -* * Lay\_L, Lay\_Left -* * Lay\_R, Lay\_Right +- Layout +- - Lay_U, Lay_Up +- - Lay_D, Lay_Down +- - Lay_L, Lay_Left +- - Lay_R, Lay_Right 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. diff --git a/docs/classDiagram.md b/docs/classDiagram.md index 8bdb7bf62..f2c4f90df 100644 --- a/docs/classDiagram.md +++ b/docs/classDiagram.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Class diagrams > "In software engineering, a class diagram in the Unified Modeling Language (UML) is a type of static structure diagram that describes the structure of a system by showing the system's classes, their attributes, operations (or methods), and the relationships among objects." @@ -63,9 +64,9 @@ classDiagram 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: -* 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 bottom compartment contains the operations the class can execute. They are also left-aligned and the first letter is lowercase. +- 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 bottom compartment contains the operations the class can execute. They are also left-aligned and the first letter is lowercase. ```mermaid-example classDiagram @@ -91,8 +92,8 @@ classDiagram There are two ways to define a 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`. +- 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`. ```mermaid-example classDiagram @@ -116,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 : -* 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 classDiagram @@ -136,7 +137,7 @@ BankAccount : +deposit(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 classDiagram @@ -160,7 +161,7 @@ class BankAccount{ #### 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 classDiagram @@ -224,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: -* `+` Public -* `-` Private -* `#` Protected -* `~` Package/Internal +- `+` Public +- `-` Private +- `#` Protected +- `~` 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()*` -> * `$` Static e.g.: `someStaticMethod()$` +> - `*` Abstract e.g.: `someAbstractMethod()*` +> - `$` 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 @@ -246,16 +247,16 @@ A relationship is a general term covering the specific types of logical connecti There are eight different types of relations defined for classes under UML which are currently supported: -| Type | Description | -| ----- | ------------- | -| <|-- | Inheritance | -| \*-- | Composition | -| o-- | Aggregation | -| --> | Association | -| -- | Link (Solid) | -| ..> | Dependency | -| ..|> | Realization | -| .. | Link (Dashed) | +| Type | Description | +| ---- | ------------- | ----------- | +| < | -- | Inheritance | +| \*-- | Composition | +| o-- | Aggregation | +| --> | Association | +| -- | Link (Solid) | +| ..> | Dependency | +| .. | > | Realization | +| .. | Link (Dashed) | ```mermaid-example classDiagram @@ -347,13 +348,13 @@ Here is the syntax: Where `Relation Type` can be one of: | Type | Description | -| ---- | ----------- | -| <| | Inheritance | +| ---- | ----------- | ----------- | +| < | | Inheritance | | \* | Composition | | o | Aggregation | | > | Association | | < | Association | -| |> | Realization | +| | > | Realization | And `Link` can be one of: @@ -370,13 +371,13 @@ Multiplicity notations are placed near the end of an association. The different cardinality options are : -* `1` Only 1 -* `0..1` Zero or One -* `1..*` One or more -* `*` Many -* `n` n {where n>1} -* `0..n` zero to n {where n>1} -* `1..n` one to n {where n>1} +- `1` Only 1 +- `0..1` Zero or One +- `1..*` One or more +- `*` Many +- `n` n {where n>1} +- `0..n` zero 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: @@ -398,16 +399,16 @@ classDiagram ## 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 -* `<<Abstract>>` To represent an abstract class -* `<<Service>>` To represent a service class -* `<<Enumeration>>` To represent an enum +- `<<Interface>>` To represent an Interface class +- `<<Abstract>>` To represent an abstract class +- `<<Service>>` To represent a service class +- `<<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: -* In a ***separate line*** after a class is defined: +- In a **_separate line_** after a class is defined: ```mermaid-example classDiagram @@ -425,7 +426,7 @@ Shape : noOfVertices Shape : draw() ``` -* In a ***nested structure*** along with the class definition: +- In a **_nested structure_** along with the class definition: ```mermaid-example classDiagram @@ -527,15 +528,15 @@ You would define these actions on a separate line after all classes have been de click className call callback() "tooltip" click className href "url" "tooltip" -* *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 -* *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.) -* note: callback function will be called with the nodeId as parameter. +- _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 +- _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.) +- note: callback function will be called with the nodeId as parameter. ### Examples -*URL Link:* +_URL Link:_ ```mmd classDiagram @@ -545,7 +546,7 @@ class Shape2 click Shape2 href "https://www.github.com" "This is a tooltip for a link" ``` -*Callback:* +_Callback:_ ```mmd classDiagram @@ -558,7 +559,7 @@ click Shape2 call callbackFunction() "This is a tooltip for a callback" ```html <script> var callbackFunction = function () { - alert('A callback was triggered'); + alert('A callback was triggered'); }; </script> ``` @@ -593,43 +594,23 @@ Beginner's tip—a full example using interactive links in an HTML page: ```html <body> - <div class="mermaid"> - classDiagram - Animal <|-- Duck - Animal <|-- Fish - Animal <|-- Zebra - 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() - } + <div class="mermaid"> + classDiagram Animal <|-- Duck Animal <|-- Fish Animal <|-- Zebra 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> - callback Duck callback "Tooltip" - link Zebra "https://www.github.com" "This is a link" - </div> - - <script> - var callback = function () { - alert('A callback was triggered'); - }; - var config = { - startOnLoad: true, - securityLevel: 'loose' - }; - mermaid.initialize(config); - </script> + <script> + var callback = function () { + alert('A callback was triggered'); + }; + var config = { + startOnLoad: true, + securityLevel: 'loose', + }; + mermaid.initialize(config); + </script> </body> ``` @@ -641,10 +622,10 @@ It is possible to apply specific styles such as a thicker border or a different ```html <style> - .cssClass > rect{ - fill:#FF0000; - stroke:#FFFF00; - stroke-width:4px; + .cssClass > rect { + fill: #ff0000; + stroke: #ffff00; + stroke-width: 4px; } </style> ``` @@ -676,7 +657,7 @@ classDiagram ?> 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 diff --git a/docs/developer-docs/configuration.md b/docs/developer-docs/configuration.md index 4e27750d4..989fd7f72 100644 --- a/docs/developer-docs/configuration.md +++ b/docs/developer-docs/configuration.md @@ -1,11 +1,12 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # 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 -* 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. +- 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**. +- 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. diff --git a/docs/development.md b/docs/development.md index 0a34da064..8d8ac2f8c 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Development and Contribution 🙌 So you want to help? That's great! @@ -23,11 +24,11 @@ This means that **you should branch off your pull request from develop** and dir ## Contributing Code -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 -* 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) +- 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 +- 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: @@ -59,7 +60,7 @@ The documentation is located in the `src/docs` directory and organized according The `docs` folder will be automatically generated when committing to `src/docs` and should not be edited manually. -We encourage contributions to the documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs). We publish documentation using GitHub Pages with [Docsify](https://www.youtube.com/watch?v=TV88lp7egMw\&t=3s) +We encourage contributions to the documentation at [mermaid-js/mermaid/docs](https://github.com/mermaid-js/mermaid/tree/develop/docs). We publish documentation using GitHub Pages with [Docsify](https://www.youtube.com/watch?v=TV88lp7egMw&t=3s) ### Add Unit Tests for Parsing diff --git a/docs/diagrams-and-syntax-and-examples/flowchart.md b/docs/diagrams-and-syntax-and-examples/flowchart.md index 79b8119b6..131bef440 100644 --- a/docs/diagrams-and-syntax-and-examples/flowchart.md +++ b/docs/diagrams-and-syntax-and-examples/flowchart.md @@ -1,9 +1,11 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. -*** + +--- sort: 3 title: Flowchart ----------------- + +--- # Flowcharts - Basic Syntax @@ -37,17 +39,17 @@ graph LR Possible FlowChart orientations are: -* TB - top to bottom -* TD - top-down (same as top to bottom) -* BT - bottom to top -* RL - right to left -* LR - left to right +- TB - top to bottom +- TD - top-down (same as top to bottom) +- BT - bottom to top +- RL - right to left +- LR - left to right ## Flowcharts 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).\*\* @@ -157,7 +159,7 @@ graph LR 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) @@ -449,8 +451,8 @@ orientation), based on the nodes to which it is linked. By default, links can span any number of ranks, but you can ask for any link to be longer than the others by adding extra dashes in the link definition. -In the following example, two extra dashes are added in the link from node *B* -to node *E*, so that it spans two more ranks than regular links: +In the following example, two extra dashes are added in the link from node _B_ +to node _E_, so that it spans two more ranks than regular links: ```mermaid-example graph TD @@ -498,12 +500,12 @@ graph TD For dotted or thick links, the characters to add are equals signs or dots, as summed up in the following table: -| Length | 1 | 2 | 3 | -|-------------------|:------:|:-------:|:--------:| -| Normal | `---` | `----` | `-----` | -| Normal with arrow | `-->` | `--->` | `---->` | -| Thick | `===` | `====` | `=====` | -| Thick with arrow | `==>` | `===>` | `====>` | +| Length | 1 | 2 | 3 | +| ----------------- | :----: | :-----: | :------: | +| Normal | `---` | `----` | `-----` | +| Normal with arrow | `-->` | `--->` | `---->` | +| Thick | `===` | `====` | `=====` | +| Thick with arrow | `==>` | `===>` | `====>` | | Dotted | `-.-` | `-..-` | `-...-` | | Dotted with arrow | `-.->` | `-..->` | `-...->` | @@ -634,14 +636,14 @@ A node can have click events bound that lead to either a JavaScript callback or click nodeId callback click nodeId call callback() -* 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. +- 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. ```html <script> - var callback = function (nodeId) { - alert('A callback was triggered on ' + nodeId); - }; + var callback = function (nodeId) { + alert('A callback was triggered on ' + nodeId); + }; </script> ``` @@ -705,38 +707,33 @@ Beginner's tip—here's a full example of using interactive links in HTML: ```html <body> - <div class="mermaid"> - graph LR; - A-->B; - B-->C; - 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 class="mermaid"> + graph LR; A-->B; B-->C; 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> - <script> - var callback = function () { - alert('A callback was triggered'); - }; - var config = { - startOnLoad: true, - flowchart: { - useMaxWidth: true, - htmlLabels: true, - curve: 'cardinal' - }, - securityLevel: 'loose' - }; - mermaid.initialize(config); - </script> + <script> + var callback = function () { + alert('A callback was triggered'); + }; + var config = { + startOnLoad: true, + flowchart: { + useMaxWidth: true, + htmlLabels: true, + curve: 'cardinal', + }, + securityLevel: 'loose', + }; + mermaid.initialize(config); + </script> </body> ``` ### 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 graph LR @@ -825,8 +822,8 @@ It is also possible to predefine classes in css styles that can be applied from ```css .cssClass > rect { - fill: #FF0000; - stroke: #FFFF00; + fill: #ff0000; + stroke: #ffff00; stroke-width: 4px; } ``` @@ -855,7 +852,7 @@ If a class is named `default` it will be assigned to all nodes that do not have ## 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 graph TD @@ -875,9 +872,9 @@ graph TD ## 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. @@ -906,6 +903,6 @@ In Javascript config parameters can be set by using `mermaid.flowchartConfig`: ```javascript mermaid.flowchartConfig = { - width: '100%' -} + width: '100%', +}; ``` diff --git a/docs/directives.md b/docs/directives.md index 948c40540..35d69881a 100644 --- a/docs/directives.md +++ b/docs/directives.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Directives ## Directives @@ -7,22 +8,22 @@ Directives gives a diagram author the capability to alter the appearance of a di 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 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: +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 +- theme +- 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. +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. @@ -35,7 +36,7 @@ Mermaid basically supports two types of configuration options to be overridden b 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} %%`. -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: @@ -94,9 +95,9 @@ parsing the above generates a single `%%init%%` JSON object below, combining the ```json5 { - logLevel: 'fatal', - theme: 'dark', - startOnLoad: true + logLevel: 'fatal', + theme: 'dark', + startOnLoad: true, } ``` @@ -182,11 +183,11 @@ The following code snippet changes theme to forest: Possible logLevel values are: -* `1` for *debug*, -* `2` for *info* -* `3` for *warn* -* `4` for *error* -* `5` for *only fatal errors* +- `1` for _debug_, +- `2` for _info_ +- `3` for _warn_ +- `4` for _error_ +- `5` for _only fatal errors_ Default Value is `5`. @@ -218,13 +219,13 @@ A --> C[End] Some common flowchart configurations are: -* *htmlLabels*: true/false -* *curve*: linear/curve -* *diagramPadding*: number -* *useMaxWidth*: number +- _htmlLabels_: true/false +- _curve_: linear/curve +- _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. -*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: @@ -258,17 +259,17 @@ A --> C[End] Some common sequence configurations are: -* *width*: number -* *height*: number -* *messageAlign*: left, center, right -* *mirrorActors*: boolean -* *useMaxWidth*: boolean -* *rightAngles*: boolean -* *showSequenceNumbers*: boolean -* *wrap*: boolean +- _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* +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. diff --git a/docs/entityRelationshipDiagram.md b/docs/entityRelationshipDiagram.md index 5f2a71d1a..38378be9e 100644 --- a/docs/entityRelationshipDiagram.md +++ b/docs/entityRelationshipDiagram.md @@ -1,9 +1,10 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Entity Relationship Diagrams > An entity–relationship model (or ER model) describes interrelated things of interest in a specific domain of knowledge. A basic ER model is composed of entity types (which classify the things of interest) and specifies relationships that can exist between entities (instances of those entity types). Wikipedia. -Note that practitioners of ER modelling almost always refer to *entity types* simply as *entities*. For example the `CUSTOMER` entity *type* would be referred to simply as the `CUSTOMER` entity. This is so common it would be inadvisable to do anything else, but technically an entity is an abstract *instance* of an entity type, and this is what an ER diagram shows - abstract instances, and the relationships between them. This is why entities are always named using singular nouns. +Note that practitioners of ER modelling almost always refer to _entity types_ simply as _entities_. For example the `CUSTOMER` entity _type_ would be referred to simply as the `CUSTOMER` entity. This is so common it would be inadvisable to do anything else, but technically an entity is an abstract _instance_ of an entity type, and this is what an ER diagram shows - abstract instances, and the relationships between them. This is why entities are always named using singular nouns. Mermaid can render ER diagrams @@ -25,7 +26,7 @@ Entity names are often capitalised, although there is no accepted standard on th Relationships between entities are represented by lines with end markers representing cardinality. Mermaid uses the most popular crow's foot notation. The crow's foot intuitively conveys the possibility of many instances of the entity that it connects to. -ER diagrams can be used for various purposes, ranging from abstract logical models devoid of any implementation details, through to physical models of relational database tables. It can be useful to include attribute definitions on ER diagrams to aid comprehension of the purpose and meaning of entities. These do not necessarily need to be exhaustive; often a small subset of attributes is enough. Mermaid allows them to be defined in terms of their *type* and *name*. +ER diagrams can be used for various purposes, ranging from abstract logical models devoid of any implementation details, through to physical models of relational database tables. It can be useful to include attribute definitions on ER diagrams to aid comprehension of the purpose and meaning of entities. These do not necessarily need to be exhaustive; often a small subset of attributes is enough. Mermaid allows them to be defined in terms of their _type_ and _name_. ```mermaid-example erDiagram @@ -67,7 +68,7 @@ erDiagram } ``` -When including attributes on ER diagrams, you must decide whether to include foreign keys as attributes. This probably depends on how closely you are trying to represent relational table structures. If your diagram is a *logical* model which is not meant to imply a relational implementation, then it is better to leave these out because the associative relationships already convey the way that entities are associated. For example, a JSON data structure can implement a one-to-many relationship without the need for foreign key properties, using arrays. Similarly an object-oriented programming language may use pointers or references to collections. Even for models that are intended for relational implementation, you might decide that inclusion of foreign key attributes duplicates information already portrayed by the relationships, and does not add meaning to entities. Ultimately, it's your choice. +When including attributes on ER diagrams, you must decide whether to include foreign keys as attributes. This probably depends on how closely you are trying to represent relational table structures. If your diagram is a _logical_ model which is not meant to imply a relational implementation, then it is better to leave these out because the associative relationships already convey the way that entities are associated. For example, a JSON data structure can implement a one-to-many relationship without the need for foreign key properties, using arrays. Similarly an object-oriented programming language may use pointers or references to collections. Even for models that are intended for relational implementation, you might decide that inclusion of foreign key attributes duplicates information already portrayed by the relationships, and does not add meaning to entities. Ultimately, it's your choice. ## Syntax @@ -79,16 +80,16 @@ Mermaid syntax for ER diagrams is compatible with PlantUML, with an extension to Where: -* `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. -* `second-entity` is the name of the other entity. -* `relationship-label` describes the relationship from the perspective of the first entity. +- `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. +- `second-entity` is the name of the other entity. +- `relationship-label` describes the relationship from the perspective of the first entity. For example: PROPERTY ||--|{ ROOM : contains -This statement can be read as *a property contains one or more rooms, and a room is part of one and only one property*. You can see that the label here is from the first entity's perspective: a property contains a room, but a room does not contain a property. When considered from the perspective of the second entity, the equivalent label is usually very easy to infer. (Some ER diagrams label relationships from both perspectives, but this is not supported here, and is usually superfluous). +This statement can be read as _a property contains one or more rooms, and a room is part of one and only one property_. You can see that the label here is from the first entity's perspective: a property contains a room, but a room does not contain a property. When considered from the perspective of the second entity, the equivalent label is usually very easy to infer. (Some ER diagrams label relationships from both perspectives, but this is not supported here, and is usually superfluous). Only the `first-entity` part of a statement is mandatory. This makes it possible to show an entity with no relationships, which can be useful during iterative construction of diagrams. If any other parts of a statement are specified, then all parts are mandatory. @@ -96,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 cardinality of the first entity with respect to the second, -* whether the relationship confers identity on a 'child' entity -* the cardinality of the second entity with respect to the first +- the cardinality of the first entity with respect to the second, +- whether the relationship confers identity on a 'child' entity +- 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. @@ -111,7 +112,7 @@ Cardinality is a property that describes how many elements of another entity can ### Identification -Relationships may be classified as either *identifying* or *non-identifying* and these are rendered with either solid or dashed lines respectively. This is relevant when one of the entities in question can not have independent existence without the other. For example a firm that insures people to drive cars might need to store data on `NAMED-DRIVER`s. In modelling this we might start out by observing that a `CAR` can be driven by many `PERSON` instances, and a `PERSON` can drive many `CAR`s - both entities can exist without the other, so this is a non-identifying relationship that we might specify in Mermaid as: `PERSON }|..|{ CAR : "driver"`. Note the two dots in the middle of the relationship that will result in a dashed line being drawn between the two entities. But when this many-to-many relationship is resolved into two one-to-many relationships, we observe that a `NAMED-DRIVER` cannot exist without both a `PERSON` and a `CAR` - the relationships become identifying and would be specified using hyphens, which translate to a solid line: +Relationships may be classified as either _identifying_ or _non-identifying_ and these are rendered with either solid or dashed lines respectively. This is relevant when one of the entities in question can not have independent existence without the other. For example a firm that insures people to drive cars might need to store data on `NAMED-DRIVER`s. In modelling this we might start out by observing that a `CAR` can be driven by many `PERSON` instances, and a `PERSON` can drive many `CAR`s - both entities can exist without the other, so this is a non-identifying relationship that we might specify in Mermaid as: `PERSON }|..|{ CAR : "driver"`. Note the two dots in the middle of the relationship that will result in a dashed line being drawn between the two entities. But when this many-to-many relationship is resolved into two one-to-many relationships, we observe that a `NAMED-DRIVER` cannot exist without both a `PERSON` and a `CAR` - the relationships become identifying and would be specified using hyphens, which translate to a solid line: ```mmd erDiagram @@ -233,8 +234,8 @@ erDiagram ### Other Things -* 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 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 ## Styling diff --git a/docs/examples.md b/docs/examples.md index 5ce995a57..174a2c986 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Examples This page contains a collection of examples of diagrams and charts that can be created through mermaid and its myriad applications. diff --git a/docs/faq.md b/docs/faq.md index d3d7078da..a1b6e4837 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Frequently Asked Questions 1. [How to add title to flowchart?](https://github.com/knsv/mermaid/issues/556#issuecomment-363182217) diff --git a/docs/flowchart.md b/docs/flowchart.md index 35ec58939..d59838d90 100644 --- a/docs/flowchart.md +++ b/docs/flowchart.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Flowcharts - Basic Syntax All Flowcharts are composed of **nodes**, the geometric shapes and **edges**, the arrows or lines. The mermaid code defines the way that these **nodes** and **edges** are made and interact. @@ -69,11 +70,11 @@ flowchart LR Possible FlowChart orientations are: -* TB - top to bottom -* TD - top-down/ same as top to bottom -* BT - bottom to top -* RL - right to left -* LR - left to right +- TB - top to bottom +- TD - top-down/ same as top to bottom +- BT - bottom to top +- RL - right to left +- LR - left to right ## Node shapes @@ -149,7 +150,7 @@ flowchart LR id1>This is the text in the box] ``` -Currently only the shape above is possible and not its mirror. *This might change with future releases.* +Currently only the shape above is possible and not its mirror. _This might change with future releases._ ### A node (rhombus) @@ -452,8 +453,8 @@ orientation), based on the nodes to which it is linked. By default, links can span any number of ranks, but you can ask for any link to be longer than the others by adding extra dashes in the link definition. -In the following example, two extra dashes are added in the link from node *B* -to node *E*, so that it spans two more ranks than regular links: +In the following example, two extra dashes are added in the link from node _B_ +to node _E_, so that it spans two more ranks than regular links: ```mermaid-example flowchart TD @@ -677,8 +678,8 @@ It is possible to bind a click event to a node, the click can lead to either a j click nodeId callback click nodeId call callback() -* 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. +- 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. Examples of tooltip usage below: @@ -918,9 +919,9 @@ flowchart TD ## 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. diff --git a/docs/gantt.md b/docs/gantt.md index 8c3968e48..95ff543d3 100644 --- a/docs/gantt.md +++ b/docs/gantt.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Gantt diagrams > 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. @@ -127,35 +128,35 @@ It is possible to set multiple dependencies separated by space: ### 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 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 -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 -gantt +gantt dateFormat HH:mm axisFormat %H:%M Initial milestone : milestone, m1, 17:49,2min taska2 : 10min -taska3 : 5min +taska3 : 5min Final milestone : milestone, m2, 18:14, 2min ``` ```mermaid -gantt +gantt dateFormat HH:mm axisFormat %H:%M Initial milestone : milestone, m1, 17:49,2min taska2 : 10min -taska3 : 5min +taska3 : 5min Final milestone : milestone, m2, 18:14, 2min ``` @@ -254,13 +255,13 @@ Styling of the a gantt diagram is done by defining a number of css classes. Duri ### Classes used Class | Description -\--- | --- -grid.tick | Styling for the Grid Lines -grid.path | Styling for the Grid's borders -.taskText | Task Text Styling +\--- | --- +grid.tick | Styling for the Grid Lines +grid.path | Styling for the Grid's borders +.taskText | Task Text Styling .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. -todayMarker | Toggle and Styling for the "Today Marker" +.taskTextOutsideLeft | Styling for Task Text that exceeds the activity bar, towards the left. +todayMarker | Toggle and Styling for the "Today Marker" ### Sample stylesheet @@ -276,11 +277,11 @@ todayMarker | Toggle and Styling for the "Today Marker" #tag { color: white; - background: #FA283D; + background: #fa283d; width: 150px; position: absolute; display: none; - padding:3px 6px; + padding: 3px 6px; margin-left: -80px; font-size: 11px; } @@ -294,20 +295,20 @@ todayMarker | Toggle and Styling for the "Today Marker" position: absolute; width: 0; border-width: 10px; - border-bottom-color: #FA283D; + border-bottom-color: #fa283d; top: -20px; } .taskText { - fill:white; - text-anchor:middle; + fill: white; + text-anchor: middle; } .taskTextOutsideRight { - fill:black; - text-anchor:start; + fill: black; + text-anchor: start; } .taskTextOutsideLeft { - fill:black; - text-anchor:end; + fill: black; + text-anchor: end; } ``` @@ -332,12 +333,12 @@ mermaid.ganttConfig can be set to a JSON string with config parameters or the co ```javascript mermaid.ganttConfig = { - titleTopMargin:25, - barHeight:20, - barGap:4, - topPadding:75, - sidePadding:75 -} + titleTopMargin: 25, + barHeight: 20, + barGap: 4, + topPadding: 75, + sidePadding: 75, +}; ``` ### Possible configuration params: @@ -354,39 +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 href URL -* 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. +- 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. Beginner's tip—a full example using interactive links in an html context: ```html <body> - <div class="mermaid"> - gantt - dateFormat YYYY-MM-DD + <div class="mermaid"> + gantt dateFormat YYYY-MM-DD section Clickable 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> - section Clickable - 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> - - <script> - var printArguments = function(arg1, arg2, arg3) { - alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3); - } - var printTask = function(taskId) { - alert('taskId: ' + taskId); - } - var config = { - startOnLoad:true, - securityLevel:'loose', - }; - mermaid.initialize(config); - </script> + <script> + var printArguments = function (arg1, arg2, arg3) { + alert('printArguments called with arguments: ' + arg1 + ', ' + arg2 + ', ' + arg3); + }; + var printTask = function (taskId) { + alert('taskId: ' + taskId); + }; + var config = { + startOnLoad: true, + securityLevel: 'loose', + }; + mermaid.initialize(config); + </script> </body> ``` diff --git a/docs/gitgraph.md b/docs/gitgraph.md index 3c7af655f..137f743e9 100644 --- a/docs/gitgraph.md +++ b/docs/gitgraph.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Gitgraph Diagrams > A Git Graph is a pictorial representation of git commits and git actions(commands) on various branches. @@ -37,10 +38,10 @@ Mermaid can render Git diagrams In Mermaid, we support the basic git operations like: -* *commit* : Representing a new commit on 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. -* *merge* : To merge an existing branch onto 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. +- _checkout_ : To checking out an existing branch and setting it as 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. Entity names are often capitalized, although there is no accepted standard on this, and it is not required in Mermaid. @@ -51,11 +52,11 @@ Mermaid syntax for a gitgraph is very straight-forward and simple. It follows a First thing you do is to declare your diagram type using the **gitgraph** keyword. This `gitgraph` keyword, tells Mermaid that you wish to draw a gitgraph, and parse the diagram code accordingly. -Each gitgraph, is initialized with ***main*** branch. So unless you create a different branch, by-default the commits will go to the main branch. This is driven with how git works, where in the beginning you always start with the main branch (formerly called as ***master*** branch). And by-default, `main` branch is set as your ***current branch***. +Each gitgraph, is initialized with **_main_** branch. So unless you create a different branch, by-default the commits will go to the main branch. This is driven with how git works, where in the beginning you always start with the main branch (formerly called as **_master_** branch). And by-default, `main` branch is set as your **_current branch_**. -You make use of ***commit*** keyword to register a commit on the current branch. Let see how this works: +You make use of **_commit_** keyword to register a commit on the current branch. Let see how this works: -A simple gitgraph showing three commits on the default (***main***) branch: +A simple gitgraph showing three commits on the default (**_main_**) branch: ```mermaid-example gitGraph @@ -99,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: -* `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. -* `HIGHLIGHT` : To highlight a particular commit in the diagram. Represented by a filled rectangle 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. +- `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` @@ -237,7 +238,7 @@ In Mermaid, in order to merge or join to an existing branch, you make use of the Usage example: `merge develop` -When Mermaid, reads the `merge` keyword, it finds the given branch and its head commit (the last commit on that branch), and joins it with the head commit on the **current branch**. Each merge results in a ***merge commit***, represented in the diagram with **filled double circle**. +When Mermaid, reads the `merge` keyword, it finds the given branch and its head commit (the last commit on that branch), and joins it with the head commit on the **current branch**. Each merge results in a **_merge commit_**, represented in the diagram with **filled double circle**. Let us modify our previous example to merge our two branches: @@ -281,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: -* `id`--> To override the default ID with custom ID -* `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. +- `id`--> To override the default ID with custom ID +- `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. 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` @@ -396,10 +397,10 @@ Let see an example: 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. -* `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. -* `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. +- `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. +- `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. Let's look at them one by one. @@ -751,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. -* 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 with an `order` are shown in the order of their `order` value. +- 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 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. @@ -820,13 +821,13 @@ 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: -* `base` -* `forest` -* `dark` -* `default` -* `neutral` +- `base` +- `forest` +- `dark` +- `default` +- `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: ### Base Theme @@ -1342,7 +1343,7 @@ See how the default theme is used to set the colors for the branches: > #### IMPORTANT: > > Mermaid supports the theme variables to override the default values for **up to 8 branches**, i.e., you can set the color/styling of up to 8 branches using theme variables. After this threshold of 8 branches, the theme variables are reused in the cyclic manner, i.e. the 9th branch will use the color/styling of the 1st branch, or the branch at index position '8' will use the color/styling of the branch at index position '0'. -> *More on this in the next section. See examples on **Customizing branch label colors** below* +> _More on this in the next section. See examples on **Customizing branch label colors** below_ ### Customizing branch colors diff --git a/docs/index.html b/docs/index.html index 53da216a3..e8cbf5967 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,10 +25,12 @@ <!-- <script src="http://localhost:9000/mermaid.js"></script> --> <script> // prettier-ignore - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + (function (i, s, o, g, r, a, m) { + i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () { + (i[r].q = i[r].q || []).push(arguments) + }, i[r].l = 1 * new Date(); a = s.createElement(o), + m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) + })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga'); ga('create', 'UA-153180559-1', 'auto'); if (location) { @@ -54,6 +56,7 @@ } </style> </head> + <body> <div id="app"></div> <script> diff --git a/docs/integrations.md b/docs/integrations.md index ebfbc522e..9609afe21 100644 --- a/docs/integrations.md +++ b/docs/integrations.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Integrations The following list is a compilation of different integrations and plugins that allow the rendering of mermaid definitions within other applications. @@ -7,172 +8,172 @@ They also serve as proof of concept, for the variety of things that can be built ## Productivity -* [GitHub](https://github.com) (**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) - * [svg-generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator) -* [GitLab](https://docs.gitlab.com/ee/user/markdown.html#diagrams-and-flowcharts) (**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**) -* [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**) -* [Joplin](https://joplinapp.org) (**Native support**) -* [Notion](https://notion.so) (**Native support**) -* [Observable](https://observablehq.com/@observablehq/mermaid) (**Native support**) -* [GitBook](https://gitbook.com) - * [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid) - * [Markdown with Mermaid CLI](https://github.com/miao1007/gitbook-plugin-mermaid-cli) - * [Mermaid plugin for GitBook](https://github.com/wwformat/gitbook-plugin-mermaid-pdf) -* [LiveBook](https://livebook.dev) (**Native support**) -* [Atlassian Products](https://www.atlassian.com) - * [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) - * [Auto convert diagrams in Jira](https://github.com/coddingtonbear/jirafs-mermaid) -* [Redmine](https://redmine.org) - * [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro) - * [redmine-mermaid](https://github.com/styz/redmine_mermaid) - * [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/) +- [GitHub](https://github.com) (**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) + - [svg-generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator) +- [GitLab](https://docs.gitlab.com/ee/user/markdown.html#diagrams-and-flowcharts) (**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**) +- [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) (**Native support**) +- [Joplin](https://joplinapp.org) (**Native support**) +- [Notion](https://notion.so) (**Native support**) +- [Observable](https://observablehq.com/@observablehq/mermaid) (**Native support**) +- [GitBook](https://gitbook.com) + - [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid) + - [Markdown with Mermaid CLI](https://github.com/miao1007/gitbook-plugin-mermaid-cli) + - [Mermaid plugin for GitBook](https://github.com/wwformat/gitbook-plugin-mermaid-pdf) +- [LiveBook](https://livebook.dev) (**Native support**) +- [Atlassian Products](https://www.atlassian.com) + - [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) + - [Auto convert diagrams in Jira](https://github.com/coddingtonbear/jirafs-mermaid) +- [Redmine](https://redmine.org) + - [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro) + - [redmine-mermaid](https://github.com/styz/redmine_mermaid) + - [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/) ## CRM/ERP/Similar -* [coreBOS](https://blog.corebos.org/blog/december2019) +- [coreBOS](https://blog.corebos.org/blog/december2019) ## Blogs -* [Wordpress](https://wordpress.org) - * [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md) - * [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/) -* [Hexo](https://hexo.io) - * [hexo-filter-mermaid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams) - * [hexo-tag-mermaid](https://github.com/JameChou/hexo-tag-mermaid) - * [hexo-mermaid-diagrams](https://github.com/mslxl/hexo-mermaid-diagrams) +- [Wordpress](https://wordpress.org) + - [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md) + - [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/) +- [Hexo](https://hexo.io) + - [hexo-filter-mermaid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams) + - [hexo-tag-mermaid](https://github.com/JameChou/hexo-tag-mermaid) + - [hexo-mermaid-diagrams](https://github.com/mslxl/hexo-mermaid-diagrams) ## CMS -* [VuePress](https://vuepress.vuejs.org/) - * [Plugin for Mermaid.js](https://github.com/eFrane/vuepress-plugin-mermaidjs) -* [Grav CMS](https://getgrav.org/) - * [Mermaid Diagrams](https://github.com/DanielFlaum/grav-plugin-mermaid-diagrams) - * [Gitlab Markdown Adapter](https://github.com/Goutte/grav-plugin-gitlab-markdown-adapter) +- [VuePress](https://vuepress.vuejs.org/) + - [Plugin for Mermaid.js](https://github.com/eFrane/vuepress-plugin-mermaidjs) +- [Grav CMS](https://getgrav.org/) + - [Mermaid Diagrams](https://github.com/DanielFlaum/grav-plugin-mermaid-diagrams) + - [Gitlab Markdown Adapter](https://github.com/Goutte/grav-plugin-gitlab-markdown-adapter) ## Communication -* [Discourse](https://discourse.org) - * [Mermaid Plugin](https://github.com/pnewell/discourse-mermaid), [And](https://github.com/unfoldingWord-dev/discourse-mermaid) -* [Mattermost](https://mattermost.com/) - * [Mermaid Plugin](https://github.com/SpikeTings/Mermaid) -* [phpBB](https://phpbb.com) - * [phpbb-ext-mermaid](https://github.com/AlfredoRamos/phpbb-ext-mermaid) -* [NodeBB](https://nodebb.org) - * [Mermaid Plugin](https://www.npmjs.com/package/nodebb-plugin-mermaid) +- [Discourse](https://discourse.org) + - [Mermaid Plugin](https://github.com/pnewell/discourse-mermaid), [And](https://github.com/unfoldingWord-dev/discourse-mermaid) +- [Mattermost](https://mattermost.com/) + - [Mermaid Plugin](https://github.com/SpikeTings/Mermaid) +- [phpBB](https://phpbb.com) + - [phpbb-ext-mermaid](https://github.com/AlfredoRamos/phpbb-ext-mermaid) +- [NodeBB](https://nodebb.org) + - [Mermaid Plugin](https://www.npmjs.com/package/nodebb-plugin-mermaid) ## Wikis -* [MediaWiki](https://www.mediawiki.org) - * [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid) - * [Flex Diagrams Extension](https://www.mediawiki.org/wiki/Extension:Flex_Diagrams) -* [Semantic Media Wiki](https://semantic-mediawiki.org) - * [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid) -* [FosWiki](https://foswiki.org) - * [Mermaid Plugin](https://foswiki.org/Extensions/MermaidPlugin) -* [DokuWiki](https://dokuwiki.org) - * [Flowcharts](https://www.dokuwiki.org/plugin:flowcharts?s[]=mermaid) - * [ComboStrap](https://combostrap.com/mermaid) -* [TiddlyWiki](https://tiddlywiki.com/) - * [mermaid-tw5: full js library](https://github.com/efurlanm/mermaid-tw5) - * [tw5-mermaid: wrapper for Mermaid Live](https://github.com/jasonmhoule/tw5-mermaid) +- [MediaWiki](https://www.mediawiki.org) + - [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid) + - [Flex Diagrams Extension](https://www.mediawiki.org/wiki/Extension:Flex_Diagrams) +- [Semantic Media Wiki](https://semantic-mediawiki.org) + - [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid) +- [FosWiki](https://foswiki.org) + - [Mermaid Plugin](https://foswiki.org/Extensions/MermaidPlugin) +- [DokuWiki](https://dokuwiki.org) + - [Flowcharts](https://www.dokuwiki.org/plugin:flowcharts?s[]=mermaid) + - [ComboStrap](https://combostrap.com/mermaid) +- [TiddlyWiki](https://tiddlywiki.com/) + - [mermaid-tw5: full js library](https://github.com/efurlanm/mermaid-tw5) + - [tw5-mermaid: wrapper for Mermaid Live](https://github.com/jasonmhoule/tw5-mermaid) ## Editor Plugins -* [Vs Code](https://code.visualstudio.com/) - * [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 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 Export](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.mermaid-export) - * [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf) - * [Preview](https://marketplace.visualstudio.com/items?itemName=searKing.preview-vscode) - * [Preview Sequence Diagrams](https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode) -* [Markdown-It](https://github.com/markdown-it/markdown-it) - * [Textual UML Parser](https://github.com/manastalukdar/markdown-it-textual-uml) - * [Mermaid Plugin](https://github.com/tylingsoft/markdown-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-less](https://github.com/searKing/markdown-it-mermaid-less) -* [Atom](https://atom.io) - * [Markdown Preview Enhanced](https://atom.io/packages/markdown-preview-enhanced) - * [Atom Mermaid](https://atom.io/packages/atom-mermaid) - * [Language Mermaid Syntax Highlighter](https://atom.io/packages/language-mermaid) -* [Sublime Text 3](https://sublimetext.com) - * [Mermaid Package](https://packagecontrol.io/packages/Mermaid) -* [Astah](https://astah.net) - * [Export to Mermaid](https://github.com/Avens666/Astah_Jude_UML_export_to_Markdown-mermaid-Plantuml-) -* [Light Table](http://lighttable.com/) - * [Mermaid Plugin](https://github.com/cldwalker/Mermaid) -* [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) -* [Vim](https://www.vim.org) - * [Vim Diagram Syntax](https://github.com/zhaozg/vim-diagram) -* [GNU Emacs](https://www.gnu.org/software/emacs/) - * [Major mode for .mmd files](https://github.com/abrochard/mermaid-mode) - * [Org-Mode integration](https://github.com/arnm/ob-mermaid) -* [Brackets](https://brackets.io/) - * [Mermaid Preview](https://github.com/AlanHohn/mermaid-preview) -* [Iodide](https://github.com/iodide-project/iodide) - * [iodide-mermaid-plugin](https://github.com/iodide-project/iodide-mermaid-plugin) -* [Google docs](https://docs.google.com/) - * [Mermaid plugin for google docs](https://workspace.google.com/marketplace/app/mermaid/636321283856) -* [Podlite](https://github.com/zag/podlite-desktop) - * [Named block =Diagram](https://github.com/zag/podlite/tree/main/packages/podlite-diagrams) -* [GNU Nano](https://www.nano-editor.org/) - * [Nano Mermaid](https://github.com/Yash-Singh1/nano-mermaid) +- [Vs Code](https://code.visualstudio.com/) + - [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 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 Export](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.mermaid-export) + - [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf) + - [Preview](https://marketplace.visualstudio.com/items?itemName=searKing.preview-vscode) + - [Preview Sequence Diagrams](https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode) +- [Markdown-It](https://github.com/markdown-it/markdown-it) + - [Textual UML Parser](https://github.com/manastalukdar/markdown-it-textual-uml) + - [Mermaid Plugin](https://github.com/tylingsoft/markdown-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-less](https://github.com/searKing/markdown-it-mermaid-less) +- [Atom](https://atom.io) + - [Markdown Preview Enhanced](https://atom.io/packages/markdown-preview-enhanced) + - [Atom Mermaid](https://atom.io/packages/atom-mermaid) + - [Language Mermaid Syntax Highlighter](https://atom.io/packages/language-mermaid) +- [Sublime Text 3](https://sublimetext.com) + - [Mermaid Package](https://packagecontrol.io/packages/Mermaid) +- [Astah](https://astah.net) + - [Export to Mermaid](https://github.com/Avens666/Astah_Jude_UML_export_to_Markdown-mermaid-Plantuml-) +- [Light Table](http://lighttable.com/) + - [Mermaid Plugin](https://github.com/cldwalker/Mermaid) +- [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) +- [Vim](https://www.vim.org) + - [Vim Diagram Syntax](https://github.com/zhaozg/vim-diagram) +- [GNU Emacs](https://www.gnu.org/software/emacs/) + - [Major mode for .mmd files](https://github.com/abrochard/mermaid-mode) + - [Org-Mode integration](https://github.com/arnm/ob-mermaid) +- [Brackets](https://brackets.io/) + - [Mermaid Preview](https://github.com/AlanHohn/mermaid-preview) +- [Iodide](https://github.com/iodide-project/iodide) + - [iodide-mermaid-plugin](https://github.com/iodide-project/iodide-mermaid-plugin) +- [Google docs](https://docs.google.com/) + - [Mermaid plugin for google docs](https://workspace.google.com/marketplace/app/mermaid/636321283856) +- [Podlite](https://github.com/zag/podlite-desktop) + - [Named block =Diagram](https://github.com/zag/podlite/tree/main/packages/podlite-diagrams) +- [GNU Nano](https://www.nano-editor.org/) + - [Nano Mermaid](https://github.com/Yash-Singh1/nano-mermaid) ## Document Generation -* [Sphinx](https://www.sphinx-doc.org/en/master/) - * [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) -* [remark.js](https://remark.js.org/) - * [remark-mermaid](https://github.com/temando/remark-mermaid) -* [jSDoc](https://jsdoc.app/) - * [jsdoc-mermaid](https://github.com/Jellyvision/jsdoc-mermaid) -* [MkDocs](https://mkdocs.org) - * [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/) -* [Type Doc](https://typedoc.org/) - * [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) -* [Codedoc](https://codedoc.cc/) - * [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin) -* [mdbook](https://rust-lang.github.io/mdBook/index.html) - * [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) +- [Sphinx](https://www.sphinx-doc.org/en/master/) + - [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid) +- [remark.js](https://remark.js.org/) + - [remark-mermaid](https://github.com/temando/remark-mermaid) +- [jSDoc](https://jsdoc.app/) + - [jsdoc-mermaid](https://github.com/Jellyvision/jsdoc-mermaid) +- [MkDocs](https://mkdocs.org) + - [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/) +- [Type Doc](https://typedoc.org/) + - [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) +- [Codedoc](https://codedoc.cc/) + - [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin) +- [mdbook](https://rust-lang.github.io/mdBook/index.html) + - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) ## Browser Extensions -| 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) -| 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) | -| 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)| -| 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) | - |- | - | - | -| Mermaid Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-diagrams/phfcghedmopjadpojhmmaffjmfiakfil) | - | - | - | - | -|Mermaid Markdown | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-markdown/mboeoikjijmjcjgpccghbcoegikliijg) | - | - | - | - | -| Monkeys | [🎡🔗](https://chrome.google.com/webstore/detail/monkeys-mermaid-for-githu/cplfdpoajbclbgphaphphcldamfkjlgi) | - | - | - | - | -| Mermaid Previewer | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-previewer/oidjnlhbegipkcklbdfnbkikplpghfdl) | - | - | - | - | +| 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) | +| 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) | +| 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) | +| 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) | - | - | - | - | +| Mermaid Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-diagrams/phfcghedmopjadpojhmmaffjmfiakfil) | - | - | - | - | +| Mermaid Markdown | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-markdown/mboeoikjijmjcjgpccghbcoegikliijg) | - | - | - | - | +| Monkeys | [🎡🔗](https://chrome.google.com/webstore/detail/monkeys-mermaid-for-githu/cplfdpoajbclbgphaphphcldamfkjlgi) | - | - | - | - | +| Mermaid Previewer | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-previewer/oidjnlhbegipkcklbdfnbkikplpghfdl) | - | - | - | - | ## Other -* [Jekyll](https://jekyllrb.com/) - * [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid) - * [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams) -* [Reveal.js](https://github.com/hakimel/reveal.js) - * [reveal.js-mermaid-plugin](https://github.com/ludwick/reveal.js-mermaid-plugin) -* [Bisheng](https://www.npmjs.com/package/bisheng) - * [bisheng-plugin-mermaid](https://github.com/yct21/bisheng-plugin-mermaid) -* [Reveal CK](https://github.com/jedcn/reveal-ck) - * [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) -* [ExDoc](https://github.com/elixir-lang/ex_doc) - * [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs) +- [Jekyll](https://jekyllrb.com/) + - [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid) + - [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams) +- [Reveal.js](https://github.com/hakimel/reveal.js) + - [reveal.js-mermaid-plugin](https://github.com/ludwick/reveal.js-mermaid-plugin) +- [Bisheng](https://www.npmjs.com/package/bisheng) + - [bisheng-plugin-mermaid](https://github.com/yct21/bisheng-plugin-mermaid) +- [Reveal CK](https://github.com/jedcn/reveal-ck) + - [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) +- [ExDoc](https://github.com/elixir-lang/ex_doc) + - [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs) diff --git a/docs/mermaidCLI.md b/docs/mermaidCLI.md index 8af849faf..e3249315b 100644 --- a/docs/mermaidCLI.md +++ b/docs/mermaidCLI.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # mermaid CLI mermaid CLI has been moved to [mermaid-cli](https://github.com/mermaid-js/mermaid-cli). Please read its documentation instead. diff --git a/docs/n00b-advanced.md b/docs/n00b-advanced.md index c654f24f0..4e9d74b98 100644 --- a/docs/n00b-advanced.md +++ b/docs/n00b-advanced.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Advanced n00b mermaid (Coming soon..) ## splitting mermaid code from html @@ -14,7 +15,7 @@ The actual mermaid file could for example look like this: mermaid content... -*** +--- ## mermaid configuration options diff --git a/docs/n00b-gettingStarted.md b/docs/n00b-gettingStarted.md index 363d0cd23..53144d755 100644 --- a/docs/n00b-gettingStarted.md +++ b/docs/n00b-gettingStarted.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # A Mermaid User-Guide for Beginners Mermaid is composed of three parts: Deployment, Syntax and Configuration. @@ -96,10 +97,7 @@ c. The `mermaid.initialize()` call, which dictates the appearance of diagrams an <body> Here is a mermaid diagram: <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> </body> ``` @@ -141,19 +139,13 @@ Rendering in Mermaid is initialized by `mermaid.initialize()` call. You can plac Here is one mermaid diagram: <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> And here is another: <div class="mermaid"> - graph TD - A[Client] -->|tcp_123| B - B(Load Balancer) - B -->|tcp_456| C[Server1] - B -->|tcp_456| D[Server2] + graph TD A[Client] -->|tcp_123| B B(Load Balancer) B -->|tcp_456| C[Server1] B + -->|tcp_456| D[Server2] </div> </body> </html> @@ -168,17 +160,9 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file, <meta charset="utf-8" /> </head> <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"> - 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> <script src="The\Path\In\Your\Package\mermaid.js"></script> <script> @@ -188,7 +172,7 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file, </html> ``` -*** +--- ## 4. Adding Mermaid as a dependency. @@ -205,4 +189,4 @@ In this example mermaid.js is referenced in `src` as a separate JavaScript file, **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. diff --git a/docs/n00b-overview.md b/docs/n00b-overview.md index 20d72bd8d..83723e0a2 100644 --- a/docs/n00b-overview.md +++ b/docs/n00b-overview.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Overview for Beginners **Explaining with a Diagram** @@ -26,12 +27,9 @@ It is a relatively straightforward solution to a significant hurdle with the sof > These are the Mermaid diagram definitions inside `<div>` tags, with the `class=mermaid`. ```html - <div class="mermaid"> - graph TD - A[Client] --> B[Load Balancer] - B --> C[Server01] - B --> D[Server02] - </div> +<div class="mermaid"> + graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02] +</div> ``` **render** @@ -44,10 +42,10 @@ It is a relatively straightforward solution to a significant hurdle with the sof ## Advantages of using Mermaid -* Ease to generate, modify and render diagrams when you make them. -* The number of integrations and plugins it has. -* You can add it to your or companies website. -* Diagrams can be created through comments like this in a script: +- Ease to generate, modify and render diagrams when you make them. +- The number of integrations and plugins it has. +- You can add it to your or companies website. +- Diagrams can be created through comments like this in a script: ## The catch-22 of Diagrams and Charts: diff --git a/docs/n00b-syntaxReference.md b/docs/n00b-syntaxReference.md index 855aee78d..9f18e3d28 100644 --- a/docs/n00b-syntaxReference.md +++ b/docs/n00b-syntaxReference.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # 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. @@ -43,13 +44,13 @@ The [Getting Started](./n00b-gettingStarted.md) section can also provide some pr 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| -| --- | --- |---| -| **Comments** | | | -|[`%%{``}%%`](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer.|In comments using `%%`, avoid using "{}".| -| **Flow-Charts** | | | -|'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| +| Diagram Breakers | Reason | Solution | +| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------- | +| **Comments** | | | +| [` %%{``}%% `](https://github.com/mermaid-js/mermaid/issues/1968) | Similar to [Directives](./directives.md) confuses the renderer. | In comments using `%%`, avoid using "{}". | +| **Flow-Charts** | | | +| '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 | ### Mermaid Live Editor diff --git a/docs/newDiagram.md b/docs/newDiagram.md index c04d6f3dd..a939c8d37 100644 --- a/docs/newDiagram.md +++ b/docs/newDiagram.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Adding a New Diagram/Chart 📊 ### Step 1: Grammar & Parsing @@ -9,8 +10,8 @@ This would be to define a jison grammar for the new diagram type. That should st For instance: -* the flowchart starts with the keyword graph. -* the sequence diagram starts with the keyword sequenceDiagram +- the flowchart starts with the keyword graph. +- the sequence diagram starts with the keyword sequenceDiagram #### Store data found during parsing @@ -36,17 +37,17 @@ For more info look in the example diagram type: The `yy` object has the following function: ```javascript -exports.parseError = function(err, hash){ - mermaid.parseError(err, hash) +exports.parseError = function (err, hash) { + mermaid.parseError(err, hash); }; ``` when parsing the `yy` object is initialized as per below: ```javascript -var parser -parser = exampleParser.parser -parser.yy = db +var parser; +parser = exampleParser.parser; +parser.yy = db; ``` ### Step 2: Rendering @@ -68,35 +69,35 @@ At this point when mermaid is trying to render the diagram, it will detect it as ### Setup ```javascript -var graph = require('./graphDb') -var flow = require('./parser/flow') -flow.parser.yy = graph +var graph = require('./graphDb'); +var flow = require('./parser/flow'); +flow.parser.yy = graph; ``` ### Parsing ```javascript -flow.parser.parse(text) +flow.parser.parse(text); ``` ### Data extraction ```javascript -graph.getDirection() -graph.getVertices() -graph.getEdges() +graph.getDirection(); +graph.getVertices(); +graph.getEdges(); ``` The parser is also exposed in the mermaid api by calling: ```javascript -var parser = mermaid.getParser() +var parser = mermaid.getParser(); ``` Note that the parse needs a graph object to store the data as per: ```javascript -flow.parser.yy = graph +flow.parser.yy = graph; ``` Look at `graphDb.js` for more details on that object. @@ -109,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: -* 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. -* Themes, there is a common way to modify the styling of diagrams in Mermaid. -* Comments should follow mermaid standards +- 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. +- Themes, there is a common way to modify the styling of diagrams in Mermaid. +- Comments should follow mermaid standards Here some pointers on how to handle these different areas. @@ -231,7 +232,7 @@ 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. -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 const getStyles = (options) => @@ -245,7 +246,7 @@ 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 const themes = { diff --git a/docs/pie.md b/docs/pie.md index 09009e98d..cf616fd93 100644 --- a/docs/pie.md +++ b/docs/pie.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # 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 @@ -24,16 +25,16 @@ pie title Pets adopted by volunteers Drawing a pie chart is really simple in mermaid. -* Start with `pie` keyword to begin the diagram - * `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 dataSet - * `label` for a section in the pie diagram within `" "` quotes. - * Followed by `:` colon as separator - * Followed by `positive numeric value` (supported upto two decimal places) +- Start with `pie` keyword to begin the diagram + - `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 dataSet + - `label` for a section in the pie diagram within `" "` quotes. + - Followed by `:` colon as separator + - Followed by `positive numeric value` (supported upto two decimal places) \[pie] \[showData] (OPTIONAL) -\[title] \[titlevalue] (OPTIONAL) +\[title] \[titlevalue] (OPTIONAL) "\[datakey1]" : \[dataValue1] "\[datakey2]" : \[dataValue2] "\[datakey3]" : \[dataValue3] diff --git a/docs/requirementDiagram.md b/docs/requirementDiagram.md index 499aea92c..c510183d9 100644 --- a/docs/requirementDiagram.md +++ b/docs/requirementDiagram.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Requirement Diagram > A Requirement diagram provides a visualization for requirements and their connections, to each other and other documented elements. The modeling specs follow those defined by SysML v1.6. @@ -60,11 +61,11 @@ A requirement definition contains a requirement type, name, id, text, risk, and Type, risk, and method are enumerations defined in SysML. -| Keyword | Options | -|---|---| -| Type | requirement, functionalRequirement, interfaceRequirement, performanceRequirement, physicalRequirement, designConstraint | -| Risk | Low, Medium, High | -| VerificationMethod | Analysis, Inspection, Test, Demonstration | +| Keyword | Options | +| ------------------ | ----------------------------------------------------------------------------------------------------------------------- | +| Type | requirement, functionalRequirement, interfaceRequirement, performanceRequirement, physicalRequirement, designConstraint | +| Risk | Low, Medium, High | +| VerificationMethod | Analysis, Inspection, Test, Demonstration | ### Element diff --git a/docs/security.md b/docs/security.md index 67a208397..e2990eb5b 100644 --- a/docs/security.md +++ b/docs/security.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # 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. diff --git a/docs/sequenceDiagram.md b/docs/sequenceDiagram.md index ee387d489..2ece618b1 100644 --- a/docs/sequenceDiagram.md +++ b/docs/sequenceDiagram.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Sequence diagrams > A Sequence diagram is an interaction diagram that shows how processes operate with one another and in what order. diff --git a/docs/stateDiagram.md b/docs/stateDiagram.md index 6cb8825d1..6af3b0bc4 100644 --- a/docs/stateDiagram.md +++ b/docs/stateDiagram.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # State diagrams > "A state diagram is a type of diagram used in computer science and related fields to describe the behavior of systems. State diagrams require that the system described is composed of a finite number of states; sometimes, this is indeed the case, while at other times this is a reasonable abstraction." Wikipedia @@ -242,7 +243,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 @@ -302,7 +303,7 @@ It is possible to specify a fork in the diagram using <\<fork>> <\<join>>. 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 stateDiagram-v2 @@ -400,7 +401,7 @@ stateDiagram ## 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 stateDiagram-v2 @@ -415,7 +416,7 @@ stateDiagram-v2 ## 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 diff --git a/docs/theming.md b/docs/theming.md index 29f1458b5..e7429c7f9 100644 --- a/docs/theming.md +++ b/docs/theming.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Theme Configuration With Version 8.7.0 Mermaid comes out with a system for dynamic and integrated configuration of themes. The intent is to increase the customizability and ease of styling for mermaid diagrams. @@ -275,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: -* Make the primary color a little lighter -* 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 primary color a little lighter +- set the tertiary color to a reddish shade as well +- make the edge label background differ from the subgraph by setting the edgeLabelBackground ```mermaid-example %%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#ffcccc', 'edgeLabelBackground':'#ffffee', 'tertiaryColor': '#fff0f0'}}}%% diff --git a/docs/upgrading.md b/docs/upgrading.md index 5a15f3384..95547de85 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Upgrading Some of the interfaces has been upgraded. @@ -13,14 +14,14 @@ Some of the interfaces has been upgraded. ```javascript mermaid_config = { - startOnLoad: true -} + startOnLoad: true, +}; ``` #### version 0.5.0 ```javascript mermaid.initialize({ - startOnLoad: true -}) + startOnLoad: true, +}); ``` diff --git a/docs/usage.md b/docs/usage.md index 926259435..da9caba96 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # Usage Mermaid is a JavaScript tool that makes use of a Markdown based syntax to render customizable diagrams, charts and visualizations. @@ -102,10 +103,10 @@ A `securityLevel` configuration has to first be cleared, `securityLevel` sets th Values: -* **strict**: (**default**) tags in text are encoded, click functionality is disabled -* **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 -* **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. +- **strict**: (**default**) tags in text are encoded, click functionality is disabled +- **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 +- **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 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. @@ -157,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 finer-grained control of this behavior, you can call `init` yourself with: -* a configuration object -* some nodes, as - * a node - * an array-like of nodes - * or W3C selector that will find your nodes +- a configuration object +- some nodes, as + - a node + - an array-like of nodes + - or W3C selector that will find your nodes Example: @@ -312,8 +313,8 @@ Mermaid takes a number of options which lets you tweak the rendering of the diag setting the options in mermaid. 1. Instantiation of the configuration using the initialize call -2. *Using the global mermaid object* - **Deprecated** -3. *using the global mermaid\_config object* - **Deprecated** +2. _Using the global mermaid object_ - **Deprecated** +3. _using the global mermaid_config object_ - **Deprecated** 4. Instantiation of the configuration using the **mermaid.init** call- **Deprecated** The list above has two ways too many of doing this. Three are deprecated and will eventually be removed. The list of @@ -343,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 approach are: -* mermaid.startOnLoad -* mermaid.htmlLabels +- mermaid.startOnLoad +- mermaid.htmlLabels ```javascript mermaid.startOnLoad = true; @@ -354,13 +355,13 @@ mermaid.startOnLoad = true; This way of setting the configuration is deprecated. Instead the preferred way is to use the initialize method. This functionality is only kept for backwards compatibility. ``` -## Using the mermaid\_config +## Using the mermaid_config It is possible to set some configuration via the mermaid object. The two parameters that are supported using this approach are: -* mermaid\_config.startOnLoad -* mermaid\_config.htmlLabels +- mermaid_config.startOnLoad +- mermaid_config.htmlLabels ```javascript mermaid_config.startOnLoad = true; @@ -374,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: -* mermaid\_config.startOnLoad -* mermaid\_config.htmlLabels +- mermaid_config.startOnLoad +- mermaid_config.htmlLabels ```javascript mermaid_config.startOnLoad = true; diff --git a/docs/user-journey.md b/docs/user-journey.md index 64a0c478a..9e213f425 100644 --- a/docs/user-journey.md +++ b/docs/user-journey.md @@ -1,4 +1,5 @@ # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs. + # User Journey Diagram > User journeys describe at a high level of detail exactly what steps different users take to complete a specific task within a system, application or website. This technique shows the current (as-is) user workflow, and reveals areas of improvement for the to-be workflow. (Wikipedia) diff --git a/package.json b/package.json index ae9b7fcc8..d7a80442e 100644 --- a/package.json +++ b/package.json @@ -31,8 +31,8 @@ "postbuild": "documentation build src/mermaidAPI.ts src/config.ts src/defaultConfig.ts --shallow -f md --markdown-toc false > src/docs/Setup.md; yarn docs:build", "build:watch": "yarn build:dev --watch", "release": "yarn build", - "lint": "eslint --cache ./", - "lint:fix": "yarn lint --fix", + "lint": "eslint --cache --ignore-path .gitignore .; prettier --check .", + "lint:fix": "eslint --cache --fix --ignore-path .gitignore .; prettier --write .", "e2e:depr": "yarn lint && jest e2e --config e2e/jest.config.js", "cypress": "cypress run", "cypress:open": "cypress open", @@ -101,7 +101,6 @@ "eslint-plugin-jsdoc": "^39.3.6", "eslint-plugin-json": "^3.1.0", "eslint-plugin-markdown": "^3.0.0", - "eslint-plugin-prettier": "^4.2.1", "globby": "^13.1.2", "husky": "^8.0.0", "identity-obj-proxy": "^3.0.0", @@ -138,4 +137,4 @@ "**/*.css", "**/*.scss" ] -} \ No newline at end of file +} diff --git a/src/docs.mts b/src/docs.mts index ec1db4912..dac32b758 100644 --- a/src/docs.mts +++ b/src/docs.mts @@ -6,6 +6,7 @@ import flatmap from 'unist-util-flatmap'; import { globby } from 'globby'; import { join, dirname } from 'path'; import { exec } from 'child_process'; +import prettier from 'prettier'; const verify = process.argv.includes('--verify'); let fileChanged = false; @@ -47,7 +48,10 @@ const transform = (file: string) => { const transformed = `# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit corresponding file in src/docs.\n${remark.stringify( out )}`; - verifyAndCopy(file, transformed); + verifyAndCopy( + file, + prettier.format(transformed, { parser: 'markdown', printWidth: 100, singleQuote: true }) + ); }; (async () => { @@ -64,7 +68,7 @@ const transform = (file: string) => { ); process.exit(1); } - console.log('Committing changes to the docs folder'); + console.log('Adding changes in docs folder to git'); exec('git add docs'); } })(); diff --git a/src/docs/index.html b/src/docs/index.html index fe54ad79e..e8cbf5967 100644 --- a/src/docs/index.html +++ b/src/docs/index.html @@ -25,10 +25,12 @@ <!-- <script src="http://localhost:9000/mermaid.js"></script> --> <script> // prettier-ignore - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); + (function (i, s, o, g, r, a, m) { + i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () { + (i[r].q = i[r].q || []).push(arguments) + }, i[r].l = 1 * new Date(); a = s.createElement(o), + m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) + })(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga'); ga('create', 'UA-153180559-1', 'auto'); if (location) { @@ -54,6 +56,7 @@ } </style> </head> + <body> <div id="app"></div> <script> @@ -105,7 +108,9 @@ colorize.push(currentCodeExample); return '<pre id="code' + currentCodeExample + '">' + escapeHTML(code) + '</pre>'; } else if (lang === 'mermaid') { - return '<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + '</div>'; + return ( + '<div class="mermaid">' + mermaid.render('mermaid-svg-' + num++, code) + '</div>' + ); } return this.origin.code.apply(this, arguments); }, @@ -131,7 +136,8 @@ while (!window.hasOwnProperty('monaco')) await new Promise((resolve) => setTimeout(resolve, 1000)); colorizeEverything(html).then( - (newHTML) => (document.querySelector('article.markdown-section').innerHTML = newHTML) + (newHTML) => + (document.querySelector('article.markdown-section').innerHTML = newHTML) ); })(); }); diff --git a/yarn.lock b/yarn.lock index 4e37c0dfd..a3096366f 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5608,13 +5608,6 @@ eslint-plugin-markdown@^3.0.0: dependencies: mdast-util-from-markdown "^0.8.5" -eslint-plugin-prettier@^4.2.1: - version "4.2.1" - resolved "https://registry.yarnpkg.com/eslint-plugin-prettier/-/eslint-plugin-prettier-4.2.1.tgz#651cbb88b1dab98bfd42f017a12fa6b2d993f94b" - integrity sha512-f/0rXLXUt0oFYs8ra4w49wYZBG5GKZpAYsJSm6rnYL5uVDjd+zowwMwVZHnAjf4edNrKpCDYfXDgmRE/Ak7QyQ== - dependencies: - prettier-linter-helpers "^1.0.0" - eslint-scope@5.1.1, eslint-scope@^5.1.1: version "5.1.1" resolved "https://registry.yarnpkg.com/eslint-scope/-/eslint-scope-5.1.1.tgz#e786e59a66cb92b3f6c1fb0d508aab174848f48c" @@ -5979,11 +5972,6 @@ fast-deep-equal@^3.1.1, fast-deep-equal@^3.1.3: resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== -fast-diff@^1.1.2: - version "1.2.0" - resolved "https://registry.yarnpkg.com/fast-diff/-/fast-diff-1.2.0.tgz#73ee11982d86caaf7959828d519cfe927fac5f03" - integrity sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w== - fast-glob@^3.2.11, fast-glob@^3.2.9: version "3.2.11" resolved "https://registry.yarnpkg.com/fast-glob/-/fast-glob-3.2.11.tgz#a1172ad95ceb8a16e20caa5c5e56480e5129c1d9" @@ -9799,13 +9787,6 @@ prelude-ls@~1.1.2: resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.1.2.tgz#21932a549f5e52ffd9a827f570e04be62a97da54" integrity sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ= -prettier-linter-helpers@^1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz#d23d41fe1375646de2d0104d3454a3008802cf7b" - integrity sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w== - dependencies: - fast-diff "^1.1.2" - prettier-plugin-jsdoc@^0.3.30: version "0.3.38" resolved "https://registry.yarnpkg.com/prettier-plugin-jsdoc/-/prettier-plugin-jsdoc-0.3.38.tgz#b8adbe9efc1dc11f3cc5ff0b07e0233a0fdf533d"