From 723bc9f02035a73778d533f2608b2eeb84e4b518 Mon Sep 17 00:00:00 2001 From: Stefan de Lange <37669773+langestefan@users.noreply.github.com> Date: Mon, 17 Nov 2025 02:31:01 +0100 Subject: [PATCH] Clarify enabling of mermaid feature (#3148) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add some clarification on how to enable mermaid. --------- Signed-off-by: George Araújo Co-authored-by: George Araújo --- CUSTOMIZE.md | 2 +- _posts/2021-07-04-diagrams.md | 12 +++++++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CUSTOMIZE.md b/CUSTOMIZE.md index 5a73912..f0f35d7 100644 --- a/CUSTOMIZE.md +++ b/CUSTOMIZE.md @@ -284,7 +284,7 @@ To remove the repositories, you can: ### You can also remove pages through commenting out front-matter blocks -For `.md` files in [\pages](pages/) directory, if you do not want to completely edit or delete them but save for later use, you can temporarily disable these variables. But be aware that Jekyll only recognizes front matter when it appears as uncommented. The layout, permalink, and other front-matter behavior are disabled for that file. +For `.md` files in [\pages](_pages/) directory, if you do not want to completely edit or delete them but save for later use, you can temporarily disable these variables. But be aware that Jekyll only recognizes front matter when it appears as uncommented. The layout, permalink, and other front-matter behavior are disabled for that file. For example, books.md do: diff --git a/_posts/2021-07-04-diagrams.md b/_posts/2021-07-04-diagrams.md index c85baa2..9fe65f9 100644 --- a/_posts/2021-07-04-diagrams.md +++ b/_posts/2021-07-04-diagrams.md @@ -9,7 +9,17 @@ mermaid: zoomable: true --- -This theme supports generating various diagrams from a text description using [mermaid](https://mermaid-js.github.io/mermaid/){:target="\_blank"}. Previously, this was done using the [jekyll-diagrams](https://github.com/zhustec/jekyll-diagrams){:target="\_blank"} plugin. For more information on this matter, see the [related issue](https://github.com/alshedivat/al-folio/issues/1609#issuecomment-1656995674). To disable the zooming feature, set `mermaid.zoomable` to `false` in this post frontmatter. +This theme supports generating various diagrams from a text description using [mermaid](https://mermaid-js.github.io/mermaid/){:target="\_blank"}. Previously, this was done using the [jekyll-diagrams](https://github.com/zhustec/jekyll-diagrams){:target="\_blank"} plugin. For more information on this matter, see the [related issue](https://github.com/alshedivat/al-folio/issues/1609#issuecomment-1656995674). + +To enable mermaid, you have to put the following in this post frontmatter: + +```yml +mermaid: + enabled: true + zoomable: true +``` + +To disable the zooming feature, set `mermaid: zoomable` to `false`. ## Mermaid