Skip to content

Commit

Permalink
docs: Update mermaid.init remove date
Browse files Browse the repository at this point in the history
  • Loading branch information
sidharthv96 committed Jun 27, 2024
1 parent a2cc86a commit c1052bd
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 10 deletions.
5 changes: 1 addition & 4 deletions docs/config/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ await mermaid.run({
### Calling `mermaid.init` - Deprecated

> **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
`class="mermaid"`. If you are adding content after mermaid is loaded, or otherwise need
Expand All @@ -217,9 +217,6 @@ Or with no config object, and a jQuery selection:
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

mermaid fully supports webpack. Here is a [working demo](https://github.com/mermaidjs/mermaid-webpack-demo).
Expand Down
6 changes: 1 addition & 5 deletions packages/mermaid/src/docs/config/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ await mermaid.run({
### Calling `mermaid.init` - Deprecated

```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
Expand All @@ -213,10 +213,6 @@ Or with no config object, and a jQuery selection:
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

mermaid fully supports webpack. Here is a [working demo](https://github.com/mermaidjs/mermaid-webpack-demo).
Expand Down
2 changes: 1 addition & 1 deletion packages/mermaid/src/mermaidAPI.ts
Original file line number Diff line number Diff line change
@@ -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.
*/
// @ts-ignore TODO: Investigate D3 issue
Expand Down

0 comments on commit c1052bd

Please sign in to comment.