plugin-mermaid

Gungnir
2020-03-26
2 min

npm github license

@renovamen/vuepress-plugin-mermaid 插件,用于在 VuePress 的 Markdown 中使用 Mermaid,从而在文章中加入流程图、状态图、时序图、甘特图等。

# 安装

yarn add @renovamen/vuepress-plugin-mermaid
# or
npm install @renovamen/vuepress-plugin-mermaid

然后在 .vuepress/config.js 中引入这个插件:

module.exports = {
  plugins: [
    [
      '@renovamen/vuepress-plugin-mermaid'
    ]
  ]
}

# 使用

代码块的 token info 需要为 mermaid,例子:

sequenceDiagram Alice->John: Hello John, how are you? loop Every minute John-->Alice: Great! end
代码
```mermaidjs
sequenceDiagram
  Alice->John: Hello John, how are you?
  loop Every minute
    John-->Alice: Great!
  end
```

更详细的用法可以参考 Mermaid 文档

# 开源协议

MIT