readme.md

bisheng-plugin-mermaid

This is a Bisheng plugin to generate Mermaid diagrams.

Install

Install with npm:

npm install --save bisheng-plugin-mermaid

or with yarn:

yarn add bisheng-plugin-mermaid

Plugin should be put in configuraion of theme in use:

// See example/_theme/lib/index.js
module.exports = {
  plugins: [
    'bisheng-plugin-mermaid',
  ],
}

Usage

In markdown:

```mermaid
graph TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[Car]
```

would be rendered as

License

MIT