2.0.0-beta.4 • Published 2 years ago

vuepress-plugin-mermaidjs2 v2.0.0-beta.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

npm version Build Status

VuePress Plugin for mermaid.js

Use mermaid.js Diagrams in VuePress Next

Installation

VuePress 2 Support is currently in beta testing, see below.

You can install it with

yarn add -D vuepress-plugin-mermaidjs2

or

npm install --save-dev vuepress-plugin-mermaidjs2

Then you just need to register the plugin in your .vuepress/config.js:

module.exports = {
    // ...
    plugins: [
        'vuepress-plugin-mermaidjs2'
    ]
    // ...
}

Usage

The recommended usage is to place your mermaidjs diagrams inside a fenced code block with the language 'mermaid':

```mermaid
sequenceDiagram
Alice->John: Hello John, how are you?
loop every minute
    John-->Alice: Great!
end
```

VuePress 2 Support

You can use this plugin with the upcoming (next) release of VuePress aka VuePress 2. To do so, use version 2.0.0-beta.1 or above.

Notice:

This plugin require VuePress 2.0.0-beta.48 or above.