Removed compatibility with hugo versions <v0.110.0

Updated user guide

Author: deining

layouts/partials/scripts.html

@@ -1,15 +1,10 @@
 {{ $needKaTeX  := or .Site.Params.katex.enable .Params.math .Params.chem -}}
 {{ $needmhchem := or .Site.Params.katex.mhchem.enable .Params.chem -}}
-{{ $needmermaid := .Site.Params.mermaid.enable -}}
 {{ if ge hugo.Version "0.93.0" -}}
-    {{ with .Site.Params.mermaid }}
-        {{ $needmermaid = true }}
-    {{ end }}
   {{ $needKaTeX = or $needKaTeX (.Page.Store.Get "hasKaTeX") (.Page.Store.Get "hasmhchem") -}}
   {{ $needmhchem = or $needmhchem (.Page.Store.Get "hasmhchem") -}}
-  {{ $needmermaid = or $needmermaid (.Page.Store.Get "hasmermaid") -}}
 {{ else -}}
-  {{ if or $needKaTeX $needmhchem $needmermaid -}}
+  {{ if or $needKaTeX $needmhchem -}}
     {{ warnf "Outdated Hugo version %s, consider upgrading to make full use of all theme features" hugo.Version  }}
   {{ end -}}
 {{ end -}}
@@ -75,8 +70,8 @@
 
 {{ $jsArray := slice $jsBs $jsBase $jsAnchor $jsSearch $jsPlantuml $jsMarkmap $jsDrawio -}}
 
-{{ if $needmermaid -}}
-{{ partial "scripts/mermaid.html" . -}}
+{{ if .Page.Store.Get "hasmermaid" -}}
+{{- partial "scripts/mermaid.html" . -}}
 {{ end -}}
 
 {{ $js := $jsArray | resources.Concat "js/main.js" -}}

layouts/partials/scripts/mermaid.html

@@ -1,35 +1,22 @@
-{{ $version := cond ( ge hugo.Version "0.90.0" ) "latest" "10.6.1" -}}
+{{ $version := "latest" -}}
 {{ with .Site.Params.mermaid.version -}}
 {{ $version = . -}}
 {{ end -}}
 
 {{ $cdnurl := printf "https://cdn.jsdelivr.net/npm/mermaid@%s/dist/mermaid.esm.min.mjs" $version -}}
-{{ if ge hugo.Version "0.90.0" -}}
-{{ if eq (resources.GetRemote $cdnurl) nil -}}
-{{ errorf "Invalid Mermaid version %s, could not retrieve this version from CDN" $version -}}
-{{ end -}}
-{{ else -}}
-{{ warnf "Outdated Hugo version %s, consider upgrading to make full use of all theme features" hugo.Version -}}
-{{ end -}}
+{{ with resources.GetRemote $cdnurl }}
+  {{ with .Err }}
+    {{ errorf "Could not retrieve mermaid script from CDN. Reason: %s." . }}
+  {{ end }}
+{{ else }}
+  {{ errorf "Invalid Mermaid version %s, could not retrieve this version from CDN." $version }}
+{{ end }}
 
 <script type="module" async>
 import mermaid from "{{- $cdnurl -}}";
 
 (function($) {
-    var needMermaid = false;
-
-{{ if ge hugo.Version "0.93.0" -}}
-    if ($('.mermaid').length > 0) {
-        needMermaid = true;
-    };
-{{ else -}}
-    $('.language-mermaid').parent().replaceWith(function() {
-        needMermaid = true;
-        return $('<pre class="mermaid">').text($(this).text());
-    });
-{{ end -}}
-
-    if (!needMermaid)  {
+    if ($('.mermaid').length == 0)  {
         mermaid.initialize({startOnLoad: false});
         return;
     }
@@ -52,9 +39,10 @@
         }
         return result;
     };
-    //var settings = norm(mermaid.mermaidAPI.defaultConfig, params);
-    //settings.startOnLoad = true;
-    mermaid.initialize(params);
+
+    var settings = norm(mermaid.mermaidAPI.defaultConfig, params);
+    settings.startOnLoad = true;
+    mermaid.initialize(settings);
 })(jQuery);
 
-</script>
+</script>

userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md

@@ -342,58 +342,49 @@ With Mermaid support enabled in Docsy, you can include the text definition of a
 
 The great advantage of this is anyone who can edit the page can now edit the diagram - no more hunting for the original tools and version to make a new edit.
 
-For example, the following defines a simple flowchart:
+For example, the following defines a sequence diagram:
 
 ````
 ```mermaid
-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]
-```
+sequenceDiagram
+    autonumber
+    Docsy user->>Discussion board: Ask question
+    Discussion board->>Community member: read question
+    loop Different strategies
+    Community member->>Test instance: Investigate issue raised
+    end
+    Note right of Community member: After hours of investigation:
+    Test instance-->>Community member: Come up with solution
+    Community member-->>Discussion board: Propose solution
+    Discussion board-->>Docsy user: check proposed solution
+    Docsy user->>Discussion board: Mark question as resolved
+    Docsy user->>Docsy user: Being happy```
 ````
 
-Automatically renders to:
+which is automatically rendered to:
 
 ```mermaid
-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]
+sequenceDiagram
+    autonumber
+    Docsy user->>Discussion board: Ask question
+    Discussion board->>Community member: read question
+    loop Different strategies
+    Community member->>Test instance: Investigate issue raised
+    end
+    Note right of Community member: After hours of investigation:
+    Test instance-->>Community member: Come up with solution
+    Community member-->>Discussion board: Propose solution
+    Discussion board-->>Docsy user: check proposed solution
+    Docsy user->>Discussion board: Mark question as resolved
+    Docsy user->>Docsy user: Being happy
 ```
 
-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.
+Support of Mermaid diagrams is automatically enabled as soon as you use a `mermaid` code block on your page.
 
-In case of hugo version 0.92 or lower you have to enable mermaid manually inside your `hugo.toml`/`hugo.yaml`/`hugo.json`:
-
-{{< tabpane >}}
-{{< tab header="Hugo version <= 0.92 only:" disabled=true />}}
-{{< tab header="hugo.toml" lang="toml" >}}
-[params.mermaid]
-enable = true
-{{< /tab >}}
-{{< tab header="hugo.yaml" lang="yaml" >}}
-params:
-  mermaid:
-    enable: true
-{{< /tab >}}
-{{< tab header="hugo.json" lang="json" >}}
-{
-  "params": {
-    "mermaid": {
-      "enable": true
-    }
-  }
-}
-{{< /tab >}}
-{{< /tabpane >}}
-
-By default, docsy pulls in the latest officially released version of Mermaid at build time. If that doesn't fit your needs, you can specify the wanted mermaid version inside your `hugo.toml`:
+By default, docsy pulls in the latest officially released version of Mermaid at build time. If that doesn't fit your needs, you can specify the wanted mermaid version inside your configuration file `hugo.toml`/`hugo.yaml`/`hugo.json`:
 
 {{< tabpane persistLang=false >}}
-{{< tab header="Hugo version >= 0.90 only:" disabled=true />}}
+{{< tab header="Configuration file:" disabled=true />}}
 {{< tab header="hugo.toml" lang="toml" >}}
 [params.mermaid]
 version = "10.6.1"
@@ -446,9 +437,9 @@ params:
 {{< /tab >}}
 {{< /tabpane >}}
 
-See the [Mermaid documentation](https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults) for a list of defaults that can be overridden.
+See the [Mermaid source code](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L18) for a list of defaults that can be overridden.
 
-Settings can also be overridden on a per-diagram basis by making use of the `%%init%%` header at the start of the diagram definition.  See the [Mermaid theming documentation](https://mermaid-js.github.io/mermaid/#/theming?id=themes-at-the-local-or-current-level).
+Settings can also be overridden on a per-diagram basis by making use of a [frontmatter config](http://mermaid.js.org/config/theming.html#customizing-themes-with-themevariables) block at the start of the diagram definition.
 
 ## UML Diagrams with PlantUML
 

userguide/hugo.yaml

@@ -119,8 +119,6 @@ params:
     disable_toc: false
   markmap:
     enable: true
-  mermaid:
-    version: 10.6.1
   drawio:
     enable: true