README.md

Mermaid plugin for GitBook

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

How to install it?

You can use install via NPM:

$ npm install gitbook-plugin-mermaid-gb3

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

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

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