Skip to content
Vuepress plugin for mermaid.js diagrams
JavaScript
Branch: master
Clone or download
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.
.gitignore
.npmignore
README.md
index.js
mermaid.js
package.json
yarn.lock

README.md

VuePress Plugin for mermaid.js

Use mermaid.js Diagrams in VuePress

This VuePress plugin provides a global component wrapping mermaid.js. The plugin is designed to work with VuePress v1.x.

Installation

You can install it with

yarn add -D vuepress-plugin-mermaidjs

or

npm install --save-dev vuepress-plugin-mermaidjs

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

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

Usage

The plugin provides the <mermaid>-Tag and handles the rendering of valid mermaid graph descriptions.

<mermaid>
graph TD
mermaid-->isAwesome
isAwesome-->mermaid
</mermaid>
You can’t perform that action at this time.