Skip to content

VitePress โ€” Run and Build

Requirements:

  • Node.js 18+

Install and init:

Terminal window
npm add -D vitepress
npx vitepress init

Run locally:

Terminal window
npm run docs:dev

Common scripts (in package.json):

{
"scripts": {
"docs:dev": "vitepress dev",
"docs:build": "vitepress build",
"docs:preview": "vitepress preview"
}
}

Build for production (output to .vitepress/dist/):

Terminal window
npm run docs:build

Preview production build:

Terminal window
npm run docs:preview

Deploy .vitepress/dist/ to your static host.