mirror of
https://github.com/mermaid-js/mermaid.git
synced 2025-09-25 10:20:06 +02:00
Fix doc formatting
This commit is contained in:
@@ -1407,6 +1407,15 @@ This sets the auto-wrap padding for the diagram (sides only)
|
|||||||
|
|
||||||
**Notes:** Default value: 0.
|
**Notes:** Default value: 0.
|
||||||
|
|
||||||
|
## parse
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
- `text` **[string][5]**
|
||||||
|
- `parseError` **[Function][6]?**
|
||||||
|
|
||||||
|
Returns **[boolean][7]**
|
||||||
|
|
||||||
## setSiteConfig
|
## setSiteConfig
|
||||||
|
|
||||||
## setSiteConfig
|
## setSiteConfig
|
||||||
@@ -1424,7 +1433,7 @@ function _Default value: At default, will mirror Global Config_
|
|||||||
|
|
||||||
- `conf` **MermaidConfig** The base currentConfig to use as siteConfig
|
- `conf` **MermaidConfig** The base currentConfig to use as siteConfig
|
||||||
|
|
||||||
Returns **[object][5]** The siteConfig
|
Returns **[object][8]** The siteConfig
|
||||||
|
|
||||||
## getSiteConfig
|
## getSiteConfig
|
||||||
|
|
||||||
@@ -1436,7 +1445,7 @@ Returns **[object][5]** The siteConfig
|
|||||||
|
|
||||||
**Notes**: Returns **any** values in siteConfig.
|
**Notes**: Returns **any** values in siteConfig.
|
||||||
|
|
||||||
Returns **[object][5]** The siteConfig
|
Returns **[object][8]** The siteConfig
|
||||||
|
|
||||||
## setConfig
|
## setConfig
|
||||||
|
|
||||||
@@ -1475,10 +1484,10 @@ $(function () {
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `id` **[string][6]** The id of the element to be rendered
|
- `id` **[string][5]** The id of the element to be rendered
|
||||||
- `text` **[string][6]** The graph definition
|
- `text` **[string][5]** The graph definition
|
||||||
- `cb` **function (svgCode: [string][6], bindFunctions: function (element: [Element][7]): void): void**
|
- `cb` **function (svgCode: [string][5], bindFunctions: function (element: [Element][9]): void): void**
|
||||||
- `container` **[Element][7]** Selector to element in which a div with the graph temporarily will be
|
- `container` **[Element][9]** Selector to element in which a div with the graph temporarily will be
|
||||||
inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
|
inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
|
||||||
element will be removed when rendering is completed.
|
element will be removed when rendering is completed.
|
||||||
|
|
||||||
@@ -1517,7 +1526,7 @@ Pushes in a directive to the configuration
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `directive` **[object][5]** The directive to push in
|
- `directive` **[object][8]** The directive to push in
|
||||||
|
|
||||||
## reset
|
## reset
|
||||||
|
|
||||||
@@ -1615,6 +1624,8 @@ Returns **void**
|
|||||||
[2]: Setup.md?id=render
|
[2]: Setup.md?id=render
|
||||||
[3]: 8.6.0_docs.md
|
[3]: 8.6.0_docs.md
|
||||||
[4]: #mermaidapi-configuration-defaults
|
[4]: #mermaidapi-configuration-defaults
|
||||||
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
||||||
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
|
||||||
[7]: https://developer.mozilla.org/docs/Web/API/Element
|
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|
||||||
|
[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
||||||
|
[9]: https://developer.mozilla.org/docs/Web/API/Element
|
||||||
|
@@ -31,7 +31,7 @@
|
|||||||
"build": "yarn clean; concurrently \"yarn build:code\" \"yarn build:types\"",
|
"build": "yarn clean; concurrently \"yarn build:code\" \"yarn build:types\"",
|
||||||
"docs:build": "ts-node-esm src/docs.mts",
|
"docs:build": "ts-node-esm src/docs.mts",
|
||||||
"docs:verify": "ts-node-esm src/docs.mts --verify",
|
"docs:verify": "ts-node-esm src/docs.mts --verify",
|
||||||
"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",
|
"postbuild": "documentation build src/mermaidAPI.ts src/config.ts src/defaultConfig.ts --shallow -f md --markdown-toc false > src/docs/Setup.md; prettier --write src/docs/Setup.md; yarn docs:build",
|
||||||
"release": "yarn build",
|
"release": "yarn build",
|
||||||
"lint": "eslint --cache --ignore-path .gitignore .; prettier --check .",
|
"lint": "eslint --cache --ignore-path .gitignore .; prettier --check .",
|
||||||
"lint:fix": "eslint --fix --ignore-path .gitignore .; prettier --write .",
|
"lint:fix": "eslint --fix --ignore-path .gitignore .; prettier --write .",
|
||||||
|
@@ -1405,6 +1405,15 @@ This sets the auto-wrap padding for the diagram (sides only)
|
|||||||
|
|
||||||
**Notes:** Default value: 0.
|
**Notes:** Default value: 0.
|
||||||
|
|
||||||
|
## parse
|
||||||
|
|
||||||
|
### Parameters
|
||||||
|
|
||||||
|
- `text` **[string][5]**
|
||||||
|
- `parseError` **[Function][6]?**
|
||||||
|
|
||||||
|
Returns **[boolean][7]**
|
||||||
|
|
||||||
## setSiteConfig
|
## setSiteConfig
|
||||||
|
|
||||||
## setSiteConfig
|
## setSiteConfig
|
||||||
@@ -1422,7 +1431,7 @@ function _Default value: At default, will mirror Global Config_
|
|||||||
|
|
||||||
- `conf` **MermaidConfig** The base currentConfig to use as siteConfig
|
- `conf` **MermaidConfig** The base currentConfig to use as siteConfig
|
||||||
|
|
||||||
Returns **[object][5]** The siteConfig
|
Returns **[object][8]** The siteConfig
|
||||||
|
|
||||||
## getSiteConfig
|
## getSiteConfig
|
||||||
|
|
||||||
@@ -1434,7 +1443,7 @@ Returns **[object][5]** The siteConfig
|
|||||||
|
|
||||||
**Notes**: Returns **any** values in siteConfig.
|
**Notes**: Returns **any** values in siteConfig.
|
||||||
|
|
||||||
Returns **[object][5]** The siteConfig
|
Returns **[object][8]** The siteConfig
|
||||||
|
|
||||||
## setConfig
|
## setConfig
|
||||||
|
|
||||||
@@ -1473,10 +1482,10 @@ $(function () {
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `id` **[string][6]** The id of the element to be rendered
|
- `id` **[string][5]** The id of the element to be rendered
|
||||||
- `text` **[string][6]** The graph definition
|
- `text` **[string][5]** The graph definition
|
||||||
- `cb` **function (svgCode: [string][6], bindFunctions: function (element: [Element][7]): void): void**
|
- `cb` **function (svgCode: [string][5], bindFunctions: function (element: [Element][9]): void): void**
|
||||||
- `container` **[Element][7]** Selector to element in which a div with the graph temporarily will be
|
- `container` **[Element][9]** Selector to element in which a div with the graph temporarily will be
|
||||||
inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
|
inserted. If one is provided a hidden div will be inserted in the body of the page instead. The
|
||||||
element will be removed when rendering is completed.
|
element will be removed when rendering is completed.
|
||||||
|
|
||||||
@@ -1515,7 +1524,7 @@ Pushes in a directive to the configuration
|
|||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
|
|
||||||
- `directive` **[object][5]** The directive to push in
|
- `directive` **[object][8]** The directive to push in
|
||||||
|
|
||||||
## reset
|
## reset
|
||||||
|
|
||||||
@@ -1613,6 +1622,8 @@ Returns **void**
|
|||||||
[2]: Setup.md?id=render
|
[2]: Setup.md?id=render
|
||||||
[3]: 8.6.0_docs.md
|
[3]: 8.6.0_docs.md
|
||||||
[4]: #mermaidapi-configuration-defaults
|
[4]: #mermaidapi-configuration-defaults
|
||||||
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
||||||
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
|
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
|
||||||
[7]: https://developer.mozilla.org/docs/Web/API/Element
|
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|
||||||
|
[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
|
||||||
|
[9]: https://developer.mozilla.org/docs/Web/API/Element
|
||||||
|
Reference in New Issue
Block a user