Skip to content

命令行接口

vitepress dev

使用指定目录作为根目录来启动 VitePress 开发服务器。默认为当前目录。在当前目录下运行时也可以省略 dev 命令。

用法

sh
# start in current directory, omitting `dev`
vitepress

# start in sub directory
vitepress dev [root]

选项

选项说明
--open [path]启动时打开浏览器 (boolean | string)
--port <port>指定端口 (number)
--base <path>public base URL (默认值: /) (string)
--cors启用 CORS
--strictPort如果指定的端口已被占用则退出 (boolean)
--force强制优化程序忽略缓存并重新绑定 (boolean)

vitepress build

构建用于生产环境的 VitePress 站点。

用法

sh
vitepress build [root]

选项\

选项说明
--mpa (experimental)MPA 模式 下构建,无需客户端激活 (boolean)
--base <path>public base URL (默认值: /) (string)
--target <target>转译目标 (默认值:"modules") (string)
--outDir <dir>输出目录 (默认值:.vitepress/dist) (string)
--minify [minifier]启用/禁用压缩,或指定要使用的压缩程序 (默认值:"esbuild") (boolean | "terser" | "esbuild")
--assetsInlineLimit <number>静态资源 base64 内联阈值(以字节为单位)(默认值:4096) (number)

vitepress preview

在本地预览生产版本。

用法

sh
vitepress preview [root]

选项

选项说明
--base <path>public base URL (默认值: /) (string)
--port <port>指定端口 (number)

vitepress init

在当前目录中启动安装向导

用法

sh
vitepress init

根据 MIT 许可发布。