vitepress-plugin-mermaid
Version:
Add mermaid support for Vitepress
47 lines (35 loc) • 929 B
Markdown
# vitepress-plugin-mermaid
Add mermaid support for Vitepress.
It detects any dark theme that are set in body as long as it has dark in the name
See the [docs 📕](https://emersonbottero.github.io/vitepress-plugin-mermaid/)
and a [complex example 😎](https://emersonbottero.github.io/vitepress-plugin-mermaid/guide/more-examples.html#render)
## Install
npm
```bash
npm i vitepress-plugin-mermaid mermaid -D
```
pnpm
```bash
pnpm install --shamefully-hoist
```
## Setup it up
Add wrapper
```js
// .vitepress/config.js
import { withMermaid } from "vitepress-plugin-mermaid";
export default withMermaid({
// your existing vitepress config...
mermaid:{
//mermaidConfig !theme here works for ligth mode since dark theme is forced in dark mode
},
...
});
```
Use in any Markdown file
````md
<!---any-file.md-->
```mermaid
flowchart TD
Start --> Stop
```
````