From 0511d01ede2e92ec9c79ee7d82c1b37bc5589fca Mon Sep 17 00:00:00 2001 From: Laurent Franceschetti Date: Fri, 15 Nov 2024 08:37:12 +0100 Subject: [PATCH] Minor updates to the Debug section, for `extra_javascript`(#111) --- webdoc/docs/troubleshooting.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/webdoc/docs/troubleshooting.md b/webdoc/docs/troubleshooting.md index c4f2f76..c14c78e 100644 --- a/webdoc/docs/troubleshooting.md +++ b/webdoc/docs/troubleshooting.md @@ -142,6 +142,9 @@ This was fixed in version 1.0.8 of the mkdocs-mermaid2 library ## Explicit calls of the Mermaid library with `extra_javascript` +> For reference information see the [`extra_javascript` section](library.md/#using-extra_javascript) +> in the JavaScript page. + !!! Tip "Easy Fix" **Upgrade Mkdocs and Mkdocs-Macros to the latest @@ -155,9 +158,11 @@ This was fixed in version 1.0.8 of the mkdocs-mermaid2 library Remember that explicit calls to the Mermaid.js (through `extra_javascript` in the config file) are **optional** - and are considered a **hack** if the default procedure doesn't work. + and are considered a **hack** (failsafe) mecanism + for cases when the default procedure doesn't work. - **As of version 1.1 of Mkdocs-Mermaid2 the use of `extra_javascript` is DEPRECATED.** Use the [`javascript` parameter instead](library.md). + **As of version 1.1 of Mkdocs-Mermaid2 the use of `extra_javascript` is DEPRECATED, as a default solution.** + Use the [`javascript` parameter instead](library.md).