跳至内容

命令行界面

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>公共基本路径 (默认: /) (string)
--cors启用 CORS
--strictPort如果指定端口已被使用,则退出 (boolean)
--force强制优化器忽略缓存并重新打包 (boolean)

vitepress build

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

用法

sh
vitepress build [root]

选项

选项描述
--mpa (实验性)MPA 模式 下构建,不进行客户端水合 (boolean)
--base <path>公共基本路径 (默认: /) (string)
--target <target>转译目标 (默认: "modules") (string)
--outDir <dir>相对于 cwd 的输出目录 (默认: <root>/.vitepress/dist) (string)
--minify [minifier]启用/禁用压缩,或指定要使用的压缩器 (默认: "esbuild") (boolean | "terser" | "esbuild")
--assetsInlineLimit <number>静态资产 base64 内联阈值,以字节为单位 (默认: 4096) (number)

vitepress preview

本地预览生产环境构建。

用法

sh
vitepress preview [root]

选项

选项描述
--base <path>公共基本路径 (默认: /) (string)
--port <port>指定端口 (number)

vitepress init

在当前目录中启动 设置向导

用法

sh
vitepress init