diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index bea553bc34..9f7ec53e35 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -15,6 +15,8 @@ defaultContentLanguageInSubdir= true
showVisitedLinks = true
disableBreadcrumb = false
disableNextPrev = false
+ disableMermaid = false
+ customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
titleSeparator = "::"
[outputs]
diff --git a/exampleSite/content/basics/configuration/_index.en.md b/exampleSite/content/basics/configuration/_index.en.md
index 6dbce18c65..7a804950a3 100644
--- a/exampleSite/content/basics/configuration/_index.en.md
+++ b/exampleSite/content/basics/configuration/_index.en.md
@@ -35,6 +35,10 @@ Note that some of these parameters are explained in details in other sections of
disableLanguageSwitchingButton = false
# Hide breadcrumbs in the header and only show the current page title
disableBreadcrumb = true
+ # If set to true, prevents Hugo from including the mermaid module if not needed (will reduce load times and traffic)
+ disableMermaid = false
+ # Specifies the remote location of the mermaid js
+ customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
# Hide Next and Previous page buttons normally displayed full height beside content
disableNextPrev = true
# Order sections in menu by "weight" or "title". Default to "weight"
@@ -60,3 +64,14 @@ Learn theme uses the last improvement available in hugo version 20+ to generate
> Hugo generate lunrjs index.json at the root of public folder.
> When you build the site with `hugo server`, hugo generates it internally and of course it doesn’t show up in the filesystem
+
+## Mermaid
+
+The mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one.
+
+> Example:
+>
+> Mermaid is globally disabled. By default it won't be loaded by any page.
+> On page "Architecture" you need a class diagram. You can set the mermaid parameters locally to only load mermaid on this page (not on the others).
+
+You also can disable mermaid for specific pages while globally enabled.
diff --git a/exampleSite/content/basics/configuration/_index.fr.md b/exampleSite/content/basics/configuration/_index.fr.md
index fb1a4e8374..1cb5c97cbb 100644
--- a/exampleSite/content/basics/configuration/_index.fr.md
+++ b/exampleSite/content/basics/configuration/_index.fr.md
@@ -31,6 +31,10 @@ Notez que certains de ces paramètres sont expliqués en détails dans d'autres
disableInlineCopyToClipBoard = false
# Un titre est défini par défaut lorsque vous utilisez un raccourci dans le menu. Utilisez ce paramètre pour le cacher.
disableShortcutsTitle = false
+ # Si défini à true, empêche Hugo d'inclure le module "mermaid" s'il n'est pas nécessaire (réduira les temps de chargement et le trafic)
+ disableMermaid = false
+ # Spécifie l'emplacement distant du mermaid js
+ customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
# Quand vous utilisez un site multi-langue, utilisez ce paramètre pour désactiver le bouton de changement de langue.
disableLanguageSwitchingButton = false
# Ordonne les sections dans menu par poids ("weight") ou titre ("title"). Défaut à "weight"
@@ -54,3 +58,14 @@ Le thème *Learn* utilise les dernières améliorations d'Hugo pour générer un
> Hugo génère lunrjs index.json à la racine du dossier `public`.
> Quand vous générez le site avec `hugo server`, Hugo génère le fichier en mémoire, il n'est donc pas disponible sur le disque.
+
+## Mermaid
+
+Les paramètres de configuration du mermaid peuvent également être définis sur une page spécifique. Dans ce cas, le paramètre global sera écrasé par le paramètre local.
+
+> Exemple:
+>
+> Mermaid est globalement handicapé. Par défaut, elle ne sera chargée par aucune page.
+> À la page "Architecture", vous avez besoin d'un diagramme de classe. Vous pouvez régler les paramètres de mermaid localement pour ne charger que la sirène sur cette page (pas sur les autres).
+
+Vous pouvez également désactiver mermaid pour des pages spécifiques tout en l'activant globalement.
diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md
index bc1aeb6de8..b5ed111dd8 100644
--- a/exampleSite/content/shortcodes/mermaid.en.md
+++ b/exampleSite/content/shortcodes/mermaid.en.md
@@ -27,29 +27,9 @@ graph LR;
C -->|Two| E[Result two]
{{}}
-or you can use this alternative syntax:
-
- ```mermaid
- graph LR;
- A[Hard edge] -->|Link text| B(Round edge)
- B --> C{Decision}
- C -->|One| D[Result one]
- C -->|Two| E[Result two]
- ```
-
-renders as
-
-```mermaid
-graph LR;
- A[Hard edge] -->|Link text| B(Round edge)
- B --> C{Decision}
- C -->|One| D[Result one]
- C -->|Two| E[Result two]
-```
-
## Sequence example
- {{*mermaid*/>}}
+ {{* mermaid */>}}
sequenceDiagram
participant Alice
participant Bob
@@ -163,7 +143,7 @@ classDiagram
### Git example
- ```mermaid
+ {{* mermaid */>}}
gitGraph:
options
{
@@ -180,11 +160,11 @@ classDiagram
commit
commit
merge newbranch
- ```
+ {{* /mermaid*/>}}
renders as
-```mermaid
+{{
prédominent...
- John-->Alice: Super!
- John->Bob: Et toi?
- Bob-->John: Au top!
- ```
-
-renders as
-
-```mermaid
-sequenceDiagram
- participant Alice
- participant Bob
- Alice->>John: Salut John, comment vas-tu?
- loop Vérification
- John->John: Se bat contre l'hyponcodrie.
- end
- Note right of John: Les pensées rationnelles
prédominent...
- John-->Alice: Super!
- John->Bob: Et toi?
- Bob-->John: Au top!
-```
-
## GANTT Example
{{*mermaid*/>}}
@@ -130,7 +78,6 @@ sequenceDiagram
Ajout à Mermaid :1d
{{* /mermaid */>}}
-
renders as
{{