From b6aeb4ccfb32378946ca9dba30dd4aef2b7df6a8 Mon Sep 17 00:00:00 2001 From: Andreas Deininger Date: Fri, 21 Oct 2022 14:13:40 +0200 Subject: [PATCH] Auto-activation of mermaid diagrams: adapt documentation --- assets/js/mermaid.js | 2 +- layouts/partials/scripts.html | 2 +- .../diagrams-and-formulae/index.md | 55 +++++-------------- .../installation-prerequisites.md | 4 +- 4 files changed, 19 insertions(+), 44 deletions(-) diff --git a/assets/js/mermaid.js b/assets/js/mermaid.js index 90d162ebab..e361b096d4 100644 --- a/assets/js/mermaid.js +++ b/assets/js/mermaid.js @@ -1,4 +1,4 @@ -{{ $needmermaid := or .Site.Params.mermaid.enable -}} +{{ $needmermaid := .Site.Params.mermaid.enable -}} {{ if ge hugo.Version "0.93.0" -}} {{ $needmermaid = or $needmermaid (.Page.Store.Get "hasmermaid") -}} {{ end }} diff --git a/layouts/partials/scripts.html b/layouts/partials/scripts.html index b47d8ba7c4..a4a9cc028e 100644 --- a/layouts/partials/scripts.html +++ b/layouts/partials/scripts.html @@ -1,4 +1,4 @@ -{{ $needmermaid := or .Site.Params.mermaid.enable -}} +{{ $needmermaid := .Site.Params.mermaid.enable -}} {{ if ge hugo.Version "0.93.0" -}} {{ $needmermaid = or $needmermaid (.Page.Store.Get "hasmermaid") -}} {{ end }} diff --git a/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md b/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md index 94d81b5c5d..db9ee56220 100644 --- a/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md +++ b/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md @@ -269,27 +269,30 @@ For example, the following defines a simple flowchart: ```` ```mermaid -graph LR - Start --> Need{"Do I need diagrams"} - Need -- No --> Off["Set params.mermaid.enable = false"] - Need -- Yes --> HaveFun["Great! Enjoy!"] +graph TD + Start --> Need{"Hugo version >= 0.93.0"} + Need -- No --> Off["Set params.mermaid.enable = true"] + Off --> Author + Need -- Yes --> Author[Insert mermaid codeblock] ``` ```` Automatically renders to: ```mermaid -graph LR - Start --> Need{"Do I need diagrams"} - Need -- No --> Off["Set params.mermaid.enable = false"] - Need -- Yes --> HaveFun["Great! Enjoy!"] - +graph TD + Start --> Need{"Hugo version >= 0.93.0"} + Need -- No --> Off["Set params.mermaid.enable = true"] + Off --> Author + Need -- Yes --> Author[Insert mermaid codeblock] ``` -To enable/disable Mermaid, update `config.toml`/`config.yaml`/`config.json`: +With hugo version 0.93 or higher, support of Mermaid diagrams is automatically enabled as soon as you use a `mermaid` code block on your page. + +If you are using hugo version 0.92 or lower, you need to enable Mermaid manually by updating your `config.toml`/`config.yaml`/`config.json`: {{< tabpane persistLang=false >}} -{{< tab header="Configuration file:" disabled=true />}} +{{< tab header="Hugo version <= 0.92 only:" disabled=true />}} {{< tab header="config.toml" lang="toml" >}} [params.mermaid] enable = true @@ -310,38 +313,12 @@ params: {{< /tab >}} {{< /tabpane >}} -You also need to disable the `guessSyntax` from markup highlighting in `config.toml`/`config.yaml`/`config.json` for Mermaid to work: - -{{< tabpane persistLang=false >}} -{{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} -[markup] - [markup.highlight] - guessSyntax = false -{{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} -markup: - highlight: - guessSyntax: false -{{< /tab >}} -{{< tab header="config.json" lang="json" >}} -{ - "markup": { - "highlight": { - "guessSyntax": false - } - } -} -{{< /tab >}} -{{< /tabpane >}} - -You can also update settings for Mermaid, such as themes, padding, etc: +If needed, you can define custom settings for your diagrams, such as themes, padding in your `config.toml`/`config.yaml`/`config.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="config.toml" lang="toml" >}} [params.mermaid] -enable = true theme = "neutral" [params.mermaid.flowchart] @@ -350,7 +327,6 @@ diagramPadding = 6 {{< tab header="config.yaml" lang="yaml" >}} params: mermaid: - enable: true theme: neutral flowchart: diagramPadding: 6 @@ -359,7 +335,6 @@ params: { "params": { "mermaid": { - "enable": true, "theme": "neutral", "flowchart": { "diagramPadding": 6 diff --git a/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md b/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md index 5f52a35a88..4513c3a887 100644 --- a/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md +++ b/userguide/content/en/docs/get-started/docsy-as-module/installation-prerequisites.md @@ -70,7 +70,7 @@ Hugo's commands for module management require that the Go programming language i ```bash $ go version -go version go1.18.4 windows/amd64 +go version go1.19.2 windows/amd64 ``` Ensure that you are using version 1.12 or higher. @@ -84,7 +84,7 @@ Hugo's commands for module management require that the `git` client is installed ```bash git version -git version 2.37.1.windows.1 +git version 2.38.1.windows.1 ``` If no `git` client is installed on your system yet, go to the [Git website](https://git-scm.com/), download the installer for your system architecture and execute it. Afterwards, check for a successful installation.