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

docs: Update mermaid.init remove date

Browse Source
This commit is contained in:
Sidharth Vinod
2024-06-27 18:05:40 +05:30
parent a2cc86a414
commit c1052bd3c5
3 changed files with 3 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/config/usage.md
View File

@@ -193,7 +193,7 @@ await mermaid.run({
### Calling `mermaid.init` - Deprecated ### Calling `mermaid.init` - Deprecated
> **Warning** > **Warning**
> mermaid.init is deprecated in v10 and will be removed in v11. Please use mermaid.run instead. > mermaid.init is deprecated in v10 and will be removed in a future release. Please use mermaid.run instead.
By default, `mermaid.init` will be called when the document is ready, finding all elements with By default, `mermaid.init` will be called when the document is ready, finding all elements with
`class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need `class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need
@@ -217,9 +217,6 @@ Or with no config object, and a jQuery selection:
mermaid.init(undefined, $('#someId .yetAnotherClass')); mermaid.init(undefined, $('#someId .yetAnotherClass'));
``` ```
> **Warning**
> This type of integration is deprecated. Instead the preferred way of handling more complex integration is to use the mermaidAPI instead.
## Usage with webpack ## Usage with webpack
mermaid fully supports webpack. Here is a [working demo](https://github.com/mermaidjs/mermaid-webpack-demo). mermaid fully supports webpack. Here is a [working demo](https://github.com/mermaidjs/mermaid-webpack-demo).

6
packages/mermaid/src/docs/config/usage.md
View File

@@ -188,7 +188,7 @@ await mermaid.run({
### Calling `mermaid.init` - Deprecated ### Calling `mermaid.init` - Deprecated
```warning ```warning
mermaid.init is deprecated in v10 and will be removed in v11. Please use mermaid.run instead. mermaid.init is deprecated in v10 and will be removed in a future release. Please use mermaid.run instead.
``` ```
By default, `mermaid.init` will be called when the document is ready, finding all elements with By default, `mermaid.init` will be called when the document is ready, finding all elements with
@@ -213,10 +213,6 @@ Or with no config object, and a jQuery selection:
mermaid.init(undefined, $('#someId .yetAnotherClass')); mermaid.init(undefined, $('#someId .yetAnotherClass'));
``` ```
```warning
This type of integration is deprecated. Instead the preferred way of handling more complex integration is to use the mermaidAPI instead.
```
## Usage with webpack ## Usage with webpack
mermaid fully supports webpack. Here is a [working demo](https://github.com/mermaidjs/mermaid-webpack-demo). mermaid fully supports webpack. Here is a [working demo](https://github.com/mermaidjs/mermaid-webpack-demo).

2
packages/mermaid/src/mermaidAPI.ts
View File

@@ -1,5 +1,5 @@
/** /**
* This file contains functions that are used internally by mermaid * This file contains functions that are used internally by mermaid
* and is not intended to be used by the end user. * and is not intended to be used by the end user.
*/ */
// @ts-ignore TODO: Investigate D3 issue // @ts-ignore TODO: Investigate D3 issue