Command Line Interface
vitepress dev
Section titled “vitepress dev”Start VitePress dev server using designated directory as root. Defaults to current directory. The dev command can also be omitted when running in current directory.
# start in current directory, omitting `dev`
vitepress
# start in sub directory
vitepress dev [root]Options
Section titled “Options”| Option | Description |
|---|---|
--open [path] |
Open browser on startup (boolean | string) |
--port <port> |
Specify port (number) |
--base <path> |
Public base path (default: /) (string) |
--cors |
Enable CORS |
--strictPort |
Exit if specified port is already in use (boolean) |
--force |
Force the optimizer to ignore the cache and re-bundle (boolean) |
vitepress build
Section titled “vitepress build”Build the VitePress site for production.
vitepress build [root]Options
Section titled “Options”| Option | Description |
|---|---|
--mpa (experimental) |
Build in MPA mode without client-side hydration (boolean) |
--base <path> |
Public base path (default: /) (string) |
--assetsBase <url> |
URL prefix the generated assets are served from, e.g. a CDN (string) |
--target <target> |
Transpile target (default: "modules") (string) |
--outDir <dir> |
Output directory relative to cwd (default: <root>/.vitepress/dist) (string) |
--assetsInlineLimit <number> |
Static asset base64 inline threshold in bytes (default: 4096) (number) |
vitepress preview
Section titled “vitepress preview”Locally preview the production build.
vitepress preview [root]Options
Section titled “Options”| Option | Description |
|---|---|
--base <path> |
Public base path (default: /) (string) |
--assetsBase <url> |
URL prefix the generated assets are served from, e.g. a CDN (string) |
--port <port> |
Specify port (number) |
vitepress init
Section titled “vitepress init”Start the Setup Wizard in current directory.
vitepress init