From c1052bd3c5ea3b10b51a4a53f7cb7dcd383572e7 Mon Sep 17 00:00:00 2001 From: Sidharth Vinod Date: Thu, 27 Jun 2024 18:05:40 +0530 Subject: [PATCH] docs: Update mermaid.init remove date --- docs/config/usage.md | 5 +---- packages/mermaid/src/docs/config/usage.md | 6 +----- packages/mermaid/src/mermaidAPI.ts | 2 +- 3 files changed, 3 insertions(+), 10 deletions(-) diff --git a/docs/config/usage.md b/docs/config/usage.md index d853643d3..2e207213c 100644 --- a/docs/config/usage.md +++ b/docs/config/usage.md @@ -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 @@ -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). diff --git a/packages/mermaid/src/docs/config/usage.md b/packages/mermaid/src/docs/config/usage.md index eec87e49f..0886a0e44 100644 --- a/packages/mermaid/src/docs/config/usage.md +++ b/packages/mermaid/src/docs/config/usage.md @@ -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 @@ -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). diff --git a/packages/mermaid/src/mermaidAPI.ts b/packages/mermaid/src/mermaidAPI.ts index d21ebdd72..ffd7d4bea 100644 --- a/packages/mermaid/src/mermaidAPI.ts +++ b/packages/mermaid/src/mermaidAPI.ts @@ -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