Overview
This article introduces a VuePress plugin called “VuePress Plugin for mermaid.js” which allows users to use mermaid.js diagrams in their VuePress sites. The plugin provides a global component that wraps mermaid.js and is designed to work with VuePress v1.x. The article also mentions that the main documentation site for the plugin can be found at vuepress-plugin-mermaidjs.efrane.com.
Features
- Global component that wraps mermaid.js
- Works with VuePress v1.x
- Allows users to use mermaid.js diagrams in VuePress sites
Installation
To install the “VuePress Plugin for mermaid.js,” there are two options:
Option 1:
npm install vuepress-plugin-mermaidjs --save-dev
Option 2:
yarn add vuepress-plugin-mermaidjs --dev
After installation, the plugin needs to be registered in the .vuepress/config.js
file.
Summary
The “VuePress Plugin for mermaid.js” is a plugin for VuePress that allows users to include mermaid.js diagrams in their VuePress sites. It provides a global component that wraps mermaid.js and is compatible with VuePress v1.x. The plugin can be installed using either npm or yarn, and it needs to be registered in the .vuepress/config.js
file.