gitbook-plugin-mermaid-gb3

Plugin for GitBook 3 which renders Mermaid flow from markdown. Tries to work cross platform (windows/unix)

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
gitbook-plugin-mermaid-gb3
2212.1.05 years ago7 years agoMinified + gzip package size for gitbook-plugin-mermaid-gb3 in KB

Readme

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