pages/_posts/2021-07-04-diagrams.md
Stefan de Lange 723bc9f020
Clarify enabling of mermaid feature (#3148)
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>
2025-11-16 22:31:01 -03:00

1.2 KiB

layout title date tags description mermaid
post a post with diagrams 2021-07-04 17:39:00 formatting diagrams an example of a blog post with diagrams
enabled zoomable
true true

This theme supports generating various diagrams from a text description using mermaid{:target="_blank"}. Previously, this was done using the jekyll-diagrams{:target="_blank"} plugin. For more information on this matter, see the related issue.

To enable mermaid, you have to put the following in this post frontmatter:

mermaid:
  enabled: true
  zoomable: true

To disable the zooming feature, set mermaid: zoomable to false.

Mermaid

The diagram below was generated by the following code:

```mermaid
sequenceDiagram
    participant John
    participant Alice
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
```
sequenceDiagram
    participant John
    participant Alice
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!