https://github.com/morlay/gitbook-plugin-mermaid-2
https://github.com/morlay/gitbook-plugin-mermaid-2
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/morlay/gitbook-plugin-mermaid-2
- Owner: morlay
- Created: 2015-09-04T17:57:13.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2017-04-08T04:22:14.000Z (about 9 years ago)
- Last Synced: 2025-04-26T02:49:13.389Z (about 1 year ago)
- Language: JavaScript
- Size: 115 KB
- Stars: 14
- Watchers: 3
- Forks: 42
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Mermaid plugin for GitBook
Plugin for [GitBook](https://github.com/GitbookIO/gitbook) which renders [Mermaid](https://github.com/knsv/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-2
```
And use it for your book with in the book.json:
```
{
"plugins": ["mermaid-2"],
"pluginsConfig": {
"mermaid-2": {
"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;
```