vitepress-plugin-mermaid

March 25, 2025 ยท View on GitHub

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 ๐Ÿ“•
and a complex example ๐Ÿ˜Ž

Install

npm

npm i vitepress-plugin-mermaid mermaid -D

pnpm

pnpm install --shamefully-hoist 

Setup it up

Add wrapper

// .vitepress/config.js
import { withMermaid } from "vitepress-plugin-mermaid";

export default withMermaid({
  // your existing vitepress config...
  mermaid:{
    //mermaidConfig !theme here works for light mode since dark theme is forced in dark mode
  },
  ...
});

Use in any Markdown file

<!---any-file.md-->

```mermaid
flowchart TD
  Start --> Stop
```