Update for Gitbook >v3.0.0

With the release of Gitbook 3+, a branch has been created to support the new style of plugin. The plugin will function the same way, but will instead use the new Gitbook Plugin style. You can check it out in the github-3-upgrade branch, or install the plugin using the @beta flag in your gitbook plugin config.

Mermaid plugin for Gitbook

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

How to install it?

You can use install via NPM:

$ npm install gitbook-plugin-mermaid-compat

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

{
    "plugins": ["mermaid-compat"],
    "pluginsConfig": {
      "mermaid-compat": {
         "theme": "forest" // here to change the mermaid theme
      }
    }
}

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;
```