florent/pages
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify enabling of mermaid feature (#3148)

Browse Source 
Add some clarification on how to enable mermaid.

---------

Signed-off-by: George Araújo <george.gcac@gmail.com>
Co-authored-by: George Araújo <george.gcac@gmail.com>
This commit is contained in:
Stefan de Lange 2025-11-17 02:31:01 +01:00 committed by GitHub
parent fe1303ab22
commit 723bc9f020
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CUSTOMIZE.md
View File

@ -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:

12
_posts/2021-07-04-diagrams.md
View File

@ -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