命令行界面
vitepress dev
使用指定目录作为 root 启动 VitePress 开发服务器。默认为当前目录。在当前目录中运行时,dev
命令也可以省略。
用法
sh
# start in current directory, omitting `dev`
vitepress
# start in sub directory
vitepress dev [root]
选项
选项 | 描述 |
---|---|
--open [path] | 启动时打开浏览器(`boolean |
--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> | 输出目录(默认为.vitepress/dist )(string ) |
--minify [minifier] | 启用/禁用代码压缩,或指定要使用的压缩工具(默认为"esbuild" )(`boolean |
--assetsInlineLimit <number> | 静态资源的Base64内联阈值(默认为4096 字节)(number ) |
vitepress preview
本地预览生产版本。
用法
sh
vitepress preview [root]
选项
选项 | 描述 |
---|---|
--base <path> | 公共基础路径(默认为/ )(string ) |
--port <port> | 指定端口(number ) |
vitepress init
在当前目录中启动安装向导。
用法
sh
vitepress init