gitbook-plugin-mermaid-fox

Mermaid plugin for GitBook

Plugin for GitBook 3 which renders Mermaid diagrams and flow charts detected in the book markdown.

Support mermaid version 10.6.1 so that it can cover the major features of mermaid in latest version.

How to install it?

You can use install via NPM:

npm install gitbook-plugin-mermaid-fox

And use it for your book with in the book.json:

{
  "plugins": ["mermaid-fox"]
}

If error occur like TypeError: cb.apply is not a function,we can find solution at Gitbook-cli install error TypeError: cb.apply is not a function inside graceful-fs

How to use it?

Just put the code into fenced code block and tag it mermaid key word like this:

```mermaid
graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;
```

2024-06 update

Add zoom and SVG export feature for a better user experience.

• Using following config in book.js to enable zoom or export

  "mermaid-fox":{
      "zoom": true,
      "download": true
  }
  

  Default config:

  "mermaid-fox":{
      "zoom": false,
      "download": true
  }
  

• svg export

  

• zoom in and out