Auto transform mermaid-example in docs.

.eslintrc.json

@@ -30,6 +30,10 @@
     "jsdoc/multiline-blocks": "off",
     "jsdoc/newline-after-description": "off",
     "jsdoc/tag-lines": "off",
+    "jsdoc/require-param-description": "off",
+    "jsdoc/require-param-type": "off",
+    "jsdoc/require-returns": "off",
+    "jsdoc/require-returns-description": "off",
     "cypress/no-async-tests": "off",
     "json/*": ["error", "allowComments"],
     "no-empty": ["error", { "allowEmptyCatch": true }]

.github/workflows/lint.yml

@@ -37,3 +37,6 @@ jobs:
 
     - name: Run Linting
       run: yarn lint
+
+    - name: Verify Docs
+      run: yarn docs:verify

.lintstagedrc.json

@@ -1,5 +1,8 @@
 {
-  "*.{js,json,html,md}": [
-      "yarn lint:fix" 
+   "src/docs/**": [
+      "yarn docs:build"
+   ],
+   "*.{js,json,html,md}": [
+      "yarn lint:fix"
    ]
 }

docs/8.6.0_docs.md

@@ -1,3 +1,4 @@
+# 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)
@@ -21,8 +22,8 @@ The three levels of are Configuration, Global, Site and Current.
 | Site Configuration| Configurations made by site owner|
 | Current Configuration| Configurations made by Implementors|
 
-
 # Limits to Modifying Configurations
+
 **secure Array**
 
 | Parameter | Description |Type | Required | Values|
@@ -36,13 +37,14 @@ The modifiable parts of the Configuration are limited by the secure array, which
 # Secure Arrays
 
 Site owners can add to the **secure** array using this command:
-mermaidAPI.initialize( { startOnLoad: true, secure: ['parameter1', 'parameter2'] } );
+mermaidAPI.initialize( { startOnLoad: true, secure: \['parameter1', 'parameter2'] } );
 
-Default values for the `secure array` consists of: ['secure', 'securityLevel', 'startOnLoad', 'maxTextSize']. These default values are immutable.
+Default values for the `secure array` consists of: \['secure', 'securityLevel', 'startOnLoad', 'maxTextSize']. These default values are immutable.
 
 Implementors can only modify configurations using directives, and cannot change the `secure` array.
 
 # Modifying Configurations and directives:
+
 The Two types of directives: are `init` (or `initialize`) and `wrap`.
 
 ```note
@@ -52,13 +54,13 @@ All directives are enclosed in `%%{ }%%`
 Older versions of mermaid will not parse directives because `%%` will comment out the directive. This makes the update backwards-compatible.
 
 # Init
+
 `init`, or `initialize`: this directive gives the user the ability to overwrite and change the values for any configuration parameters not set in the secure array.
 
 | 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**}}%%`
 
@@ -73,6 +75,7 @@ When deployed within code, init is called before the graph/diagram description.
 ```
 
 **for example**:
+
 ```mmd
 %%{init: {"theme": "default", "logLevel": 1 }}%%
  graph LR
@@ -84,6 +87,7 @@ When deployed within code, init is called before the graph/diagram description.
   f-->g
   g-->
 ```
+
 # Wrap
 
 | Parameter | Description |Type | Required | Values|
@@ -104,8 +108,8 @@ It is a non-argument directive and can be executed thusly:
 
 ![Image showing wrapped text](img/wrapped%20text.png)
 
-
 # Resetting Configurations:
+
 There are two more functions in the mermaidAPI that can be called by site owners: **reset** and **globalReset**.
 
 **reset**: resets the configuration to whatever the last configuration was. This can be done to undo more recent changes set from the last mermaidAPI.initialize({...}) configuration.
@@ -115,6 +119,7 @@ There are two more functions in the mermaidAPI that can be called by site owners
 **Notes**: Both `reset` and `globalReset` are only available to site owners, and as such implementors have to edit their configs using `init`.
 
 # Additional Utils to mermaid
+
 •	**memoize**: simple caching for computationally expensive functions, reducing rendering time by about 90%.
 
 •	**assignWithDepth** - an improvement on previous functions with config.js and `Object.assign`. The purpose of this function is to provide a sane mechanism for merging objects, similar to `object.assign`, but with depth.
@@ -123,7 +128,6 @@ Example of **assignWithDepth**:
 
 ![Image showing assignWithDepth](img/assignWithDepth.png)
 
-
 Example of **object.Assign**:
 
 ![Image showing object.assign without depth](img/object.assign%20without%20depth.png)
@@ -132,7 +136,6 @@ Example of **object.Assign**:
 
 **Notes**: For more information on usage, parameters, and return info for these new functions take a look at the jsdocs for them in the utils package.
 
-
 # New API Requests Introduced in Version 8.6.0
 
 ## setSiteConfig
@@ -177,7 +180,6 @@ siteConfig value.
 | --------- | ------------------- | ------- | ------------------ |
 | `getConfig` |Obtains the `currentConfig` | Get Request | Any Values from `currentConfig`|
 
-
 ```note
 Returns any values in currentConfig.
 ```