VitePress
Documentation
Quickstart
Installation
mkdir my-awesome-projectcd my-awesome-project# init in root or subfoldernpx --yes vitepress init ./npx --yes vitepress init ./docs# For the `Add VitePress npm scripts to package.json?` prompt, select `Yes`npm install --save-dev vitepress
Configuration
Update your site metadata in docs/.vitepress/config.mts (e.g. titleTemplate, head, etc.).
Generating Clean URLs is supported.
Deployment
Build
npm run docs:build
Preview
# preview in root or subfoldernpx --yes serve@latest .vitepress/distnpx --yes serve@latest docs/.vitepress/dist
Deploy
npx --yes bunny-launcher@latest --interactive