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:

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