@unify-js/create-vitepress-mermaid

CLI tool to quickly scaffold vitepress-mermaid projects.

Usage

Run one of the following commands in your terminal:

# npm
npm create @unify-js/vitepress-mermaid

# pnpm
pnpm create @unify-js/vitepress-mermaid

# yarn
yarn create @unify-js/vitepress-mermaid

After entering your project name, follow the instructions to install dependencies and start the dev server:

cd <project-name>
npm install  # alternatively: pnpm install, yarn
npm run dev  # alternatively: pnpm dev, yarn dev

Features

The generated project includes:

• Pre-configured Setup - VitePress + vitepress-mermaid ready to use
• Sample Diagrams - Example Mermaid diagrams to get you started
• TypeScript Support - Full TypeScript configuration included
• Theme Integration - Dark mode support out of the box

Requirements

• Node.js >= 20.0.0

License

MIT