No description, website, or topics provided.
Branch: master
Clone or download
#4 Compare This branch is 11 commits ahead of jpreynat:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_layouts/website
book
dist Update dist from mermaid 7 Sep 2, 2017
.gitignore
.npmignore
README.md
index.js
package.json

README.md

Mermaid plugin for GitBook

Plugin for GitBook 3 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-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;
```