From ba26f87b098fef8750283ac082c26a1b9f9ab2ab Mon Sep 17 00:00:00 2001 From: Laurent Franceschetti Date: Sun, 25 Feb 2024 15:57:45 +0100 Subject: [PATCH] Webdoc: fix broken link causing warnings in #95 --- webdoc/docs/contribute.md | 2 +- webdoc/docs/description.md | 2 +- webdoc/docs/index.md | 4 ++-- webdoc/docs/library.md | 6 +++--- webdoc/docs/troubleshooting.md | 20 ++++++++++---------- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/webdoc/docs/contribute.md b/webdoc/docs/contribute.md index 3ba26de..265577a 100644 --- a/webdoc/docs/contribute.md +++ b/webdoc/docs/contribute.md @@ -2,7 +2,7 @@ 1. Contributions are welcome. 2. Before submitting an issue, consider this documentation, and particularly - the [troubleshooting](../troubleshooting) section. + the [troubleshooting](troubleshooting.md) section. 3. Use the [Issues](https://github.com/fralau/mkdocs-mermaid2-plugin/issues) to signal a bug or propose a feature you believe is necessary. 4. If this is a usage question, prefer the [discussions](https://github.com/fralau/mkdocs-mermaid2-plugin/discussions). 5. **Before submitting a PR, always open an Issue and consider the answers.** diff --git a/webdoc/docs/description.md b/webdoc/docs/description.md index 2fb8000..07fcf49 100644 --- a/webdoc/docs/description.md +++ b/webdoc/docs/description.md @@ -43,7 +43,7 @@ those segments directly into `
` elements: !!! Note "Superfences extension" The principle remains the same - when using the [Superfences](superfences) extension. + when using the [Superfences](superfences.md) extension. That extension is **not** mandatory, except when using the Material theme. diff --git a/webdoc/docs/index.md b/webdoc/docs/index.md index c50528b..26b928a 100644 --- a/webdoc/docs/index.md +++ b/webdoc/docs/index.md @@ -192,7 +192,7 @@ plugins: javascript: https://unpkg.com/mermaid@10.4.0/dist/mermaid.esm.min.mjs ``` -For more details, [see the relative page](../library). +For more details, [see the relative page](library.md). @@ -220,7 +220,7 @@ markdown_extensions: ``` -See the [technical explanation](superfences/#usage-for-the-material-theme). +See the [technical explanation](superfences.md/#usage-for-the-material-theme). ### Other Themes diff --git a/webdoc/docs/library.md b/webdoc/docs/library.md index 700bcd5..d02e339 100644 --- a/webdoc/docs/library.md +++ b/webdoc/docs/library.md @@ -4,7 +4,7 @@ ## Introduction By default, MkDocs-Mermaid2 automatically inserts the proper calls to -[the Mermaid.js library, according to the correct version](../description/#insertion-of-the-javascript-library) (all-in one file, or ESM), +[the Mermaid.js library, according to the correct version](description.md/#insertion-of-the-javascript-library) (all-in one file, or ESM), so that the diagrams are correctly interpreted. You may, however, specify your own version, using to the @@ -22,8 +22,8 @@ The files can be found on [unpkg](https://unpkg.com/browse/mermaid@10.4.0/) or [ Mkdocs-Mermaid2 will still insert the appropriate call to the library into the HTML page, according to the type of library (as all-in-one -javascript function, or [ESM module](../description/#automatic-insertion-of-the-javascript-library)), as well as the [initialization -sequence](../description/#initialization-sequence). +javascript function, or [ESM module](description.md/#automatic-insertion-of-the-javascript-library)), as well as the [initialization +sequence](description.md/#initialization-sequence). To determine which version, it will use the extension: diff --git a/webdoc/docs/troubleshooting.md b/webdoc/docs/troubleshooting.md index 453d9db..e17712e 100644 --- a/webdoc/docs/troubleshooting.md +++ b/webdoc/docs/troubleshooting.md @@ -59,7 +59,7 @@ In that case, the javascript library was probably not called. If you are using the superfences extension, but you see the source code, you probably forgot to declare the custom_fences, or declared the wrong one. -Se more explanations under [Declaring the superfences extension](superfences#specifying-the-mermaid-custom-fence) +Se more explanations under [Declaring the superfences extension](superfences.md#specifying-the-mermaid-custom-fence) !!! Tip **Examine the HTML code produced in the page and see the next questions.** @@ -100,12 +100,12 @@ Control the link used in the HTML page generated, e.g.: Check the version of the javascript mermaid library you are using (it's indicated in the error message; as a last resort, check in the html page). -You can [change the library version if needed](../#specifying-the-version-of-the-mermaid-library). +You can [change the library version if needed](index.md/#specifying-the-version-of-the-mermaid-library). ### The arguments in the config file (color, etc.) do not work -For example, the following specification ([see description](../#other-themes)) does not work: +For example, the following specification ([see description](index.md/#other-themes)) does not work: ```yaml plugins: @@ -145,19 +145,19 @@ This was fixed in version 1.0.8 of the mkdocs-mermaid2 library !!! Tip "Easy Fix" **Upgrade Mkdocs and Mkdocs-Macros to the latest - version and stop using `extra_javascript`. Use the [`javascript` parameter instead](../library)**. + version and stop using `extra_javascript`. Use the [`javascript` parameter instead](library.md)**. Otherwise, read on. !!! Warning "Important" - If you [specify the version number in the config file](/#specifying-the-version-of-the-mermaid-library), then - the mkdocs-mermaid2 will insert the correct calls for you. + If you [specify the version number in the config file](index.md/#specifying-the-version-of-the-mermaid-library), + then the mkdocs-mermaid2 will insert the correct calls for you. 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. - **As of version 1.1 of Mkdocs-Mermaid2 the use of `extra_javascript` is DEPRECATED.** Use the [`javascript` parameter instead](../library). + **As of version 1.1 of Mkdocs-Mermaid2 the use of `extra_javascript` is DEPRECATED.** Use the [`javascript` parameter instead](library.md). @@ -266,7 +266,7 @@ As an ESM javascript library, Mermaid.js requires an `import` statement. For some reason, they require the `mermaid2.fence_mermaid` function in order to work. It means that with the Material theme, your diagrams will not inherit the theme's color - ([see more information on this subject](../superfences/#usage-for-the-material-theme)). + ([see more information on this subject](superfences.md/#usage-for-the-material-theme)). @@ -275,11 +275,11 @@ As an ESM javascript library, Mermaid.js requires an `import` statement. ### Rich text diagrams, or links are not displayed properly? -1. As a first step, [set the security level to 'loose'](../tips/#setting-the-security-level-to-loose). +1. As a first step, [set the security level to 'loose'](tips.md/#setting-the-security-level-to-loose). 2. Make sure you use a compatible version of the javascript library (8.6.4, 8.8.0, ~~8.7.0~~). In principle, the version used by the plugin is compatible (see instructions to - [change the version](../#specifying-the-version-of-the-mermaid-library)). + [change the version](index.md/#specifying-the-version-of-the-mermaid-library)). ### With pymdownx.details, diagrams in collapsed elements are not displayed?