marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-24 09:49:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Relase 8.6.0

Browse Source
This commit is contained in:
Knut Sveidqvist
2020-07-13 16:39:52 +02:00
parent 9e8c9e897f
commit 686ee1e349
11 changed files with 73 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/8.6.0_docs.md
View File

@@ -1,5 +1,5 @@
# Version 8.6.0 Changes
**Edit this Page** [![N|Solid](https://github.com/NeilCuzon/mermaid/blob/develop/docs/img/GitHub-Mark-32px.png)](https://github.com/NeilCuzon/mermaid/edit/develop/docs/8.6.0_docs.md)
**Edit this Page** [![N|Solid](/img/GitHub-Mark-32px.png)](https://github.com/medmaid-js/mermaid/edit/develop/docs/8.6.0_docs.md)
**Try out the Beta Version of the [[New Mermaid Live-Editor](https://mermaid-js.github.io/docs/mermaid-live-editor-beta/#/edit/eyJjb2RlIjoiJSV7aW5pdDoge1widGhlbWVcIjogXCJmb3Jlc3RcIiwgXCJsb2dMZXZlbFwiOiAxIH19JSVcbmdyYXBoIFREXG4gIEFbQ2hyaXN0bWFzXSAtLT58R2V0IG1vbmV5fCBCKEdvIHNob3BwaW5nKVxuICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgQyAtLT58T25lfCBEW0xhcHRvcF1cbiAgQyAtLT58VHdvfCBFW2lQaG9uZV1cbiAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl1cblx0XHQiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGFyayJ9fQ)]**
@@ -50,7 +50,7 @@ init, or initialize: the init or initialize directive gives the user the ability
| --- | --- | --- | --- | --- |
| init | modifies configurations| Directive| Optional | Any parameters not included in the secure array|
**Notes:**
**Notes:**
init would be an argument-directive: %%{init: { **insert argument here**}}%%
@@ -89,7 +89,7 @@ It is a non-argument directive and can be executed thusly:
**an example of text wrapping in a sequence diagram**:
![Image showing wrapped text](https://github.com/NeilCuzon/mermaid/blob/develop/docs/img/wrapped%20text.png)
![Image showing wrapped text](/img/wrapped%20text.png)
# Resetting Configurations:
@@ -108,12 +108,12 @@ There are two more functions in the mermaidAPI that can be called by site owners
Example of **assignWithDepth**:
![Image showing assignWithDepth](https://github.com/NeilCuzon/mermaid/blob/develop/docs/img/assignWithDepth.png)
![Image showing assignWithDepth](/img/assignWithDepth.png)
Example of **object.Assign**:
![Image showing object.assign without depth](https://github.com/NeilCuzon/mermaid/blob/develop/docs/img/object.assign%20without%20depth.png)
![Image showing object.assign without depth](/img/object.assign%20without%20depth.png)
• **calculateTextDimensions, calculateTextWidth,** and **calculateTextHeight** - for measuring text dimensions, width and height.

22
docs/Setup.md
View File

@@ -11,13 +11,9 @@ It is is then up to the user of the API to make use of the svg, either insert it
In addition to the render function, a number of behavioral configuration options are available.
# Configuration
# **Configuration methods in Mermaid version 8.6.0 have been updated, to learn more[[click here](https://github.com/NeilCuzon/mermaid/blob/develop/docs/8.6.0_docs.md)].**
## Configuration
**Configuration methods in Mermaid version 8.6.0 have been updated, to learn more\[[click here][2]].**
## **What follows are config instructions for older versions**
@@ -50,7 +46,7 @@ mermaid.initialize({
</script>
</pre>
A summary of all options and their defaults is found [here][2]. A description of each option follows below.
A summary of all options and their defaults is found [here][3]. A description of each option follows below.
## theme
@@ -58,9 +54,9 @@ theme , the CSS style sheet
theme , the CSS style sheet
| Parameter | Description |Type | Required | Values|
| --- | --- | --- | --- | --- |
| Theme |Built in Themes| String | Optional | default, forest, dark, neutral, null|
| Parameter | Description | Type | Required | Values |
| --------- | --------------- | ------ | -------- | ---------------------------------------------------- |
| Theme | Built in Themes | String | Optional | Values include, default, forest, dark, neutral, null |
**Notes:**To disable any pre-defined mermaid theme, use "null".
@@ -850,6 +846,8 @@ Resets this currentConfig to conf
- `conf` the base currentConfig to reset to (default: current siteConfig ) (optional, default `getSiteConfig()`)
[1]: https://github.com/knsv/mermaid/blob/master/docs/mermaidAPI.md#render
[1]: Setup.md?id=render
[2]: https://github.com/knsv/mermaid/blob/master/docs/Setup.md#mermaidapi-configuration-defaults
[2]: 8.6.0_docs.md
[3]: #mermaidapi-configuration-defaults