首页/新闻资讯/正文详情

VitePress 命令行接口(CLI)完整参考:dev / build / preview / init 命令实战指南

发布时间:2026/9/21 2:15:46 来源:云帆数科 栏目:资讯中心
VitePress 命令行接口(CLI)完整参考:dev / build / preview / init 命令实战指南
前端文档【免费下载链接】vitepressVite Vue powered static site generator.项目地址https://gitcode.com/gh_mirrors/vi/vitepress点击查看免费下载本篇指南基于 VitePress 官方文档 命令行接口参考 展开系统讲解vitepress dev、vitepress build、vitepress preview与vitepress init四个核心命令的用法、选项参数与底层实现原理。读完本文你将掌握本地开发、生产构建、产物预览与项目初始化四条完整工作流并能结合 src/node/cli.ts 的源码理解每个命令背后的解析与执行逻辑。VitePress 的所有 CLI 命令都通过bin字段注册为vitepress可执行文件见 package.json默认以当前目录作为站点根目录。命令行入口 src/node/cli.ts 使用minimist解析参数并将形如--force的布尔参数从字符串true/false归一化为真正的布尔值再根据第一个位置参数分发到dev、init、build、serve/preview四个分支。命令总览命令作用常用场景vitepress dev可省略启动开发服务器本地编写与预览文档vitepress build构建生产版本部署前的静态产物生成vitepress preview别名serve本地预览生产构建产物验证构建结果、检查 base 路径vitepress init交互式安装向导初始化新站点脚手架其中vitepress与vitepress dev等价在 src/node/cli.ts 中当command为空或为dev时都会进入开发服务器启动分支。serve是preview的兼容别名两者在 src/node/cli.ts 中走同一执行路径。vitepress dev启动开发服务器使用指定目录作为根目录启动 VitePress 开发服务器默认根目录为当前目录。用法# 从当前目录启动dev 可省略 vitepress # 从子目录启动 vitepress dev [root] # 例如 vitepress dev docs当省略dev直接运行vitepress时第一个位置参数即被解释为根目录源码中的对应逻辑为const root argv._[command ? 1 : 0]src/node/cli.ts。选项选项说明--open [path]启动时打开浏览器boolean \| string。不带值则打开默认页面带值可指定路径--port port指定端口number默认由 Vite 自动选择可用端口--base pathpublic base URL默认值/string--cors启用 CORS便于跨域调试--strictPort若指定端口已被占用则直接退出boolean而非自动换端口--force强制优化程序忽略缓存并重新绑定boolean源码实现与快捷键--force选项在 CLI 入口被转换为optimizeDeps: { force: true }传入 Vitesrc/node/cli.ts用于清除依赖预构建缓存。开发服务器通过 createServer 创建其内部将srcDir作为 Vite 根目录、把site.base作为 Vite base并挂载由 createVitePressPlugin 生成的一组插件rewrites、Vue 编译、web fonts、assetsBase、icons、local search、静态数据与动态路由等。vitepress dev启动后支持终端快捷键由 shortcuts.ts 注册仅在交互式 TTY 且非 CI 环境下生效按键功能h显示快捷键帮助r重启开发服务器会重新解析配置、清理 Markdown 编译缓存u显示服务器地址o在浏览器中打开站点c清空控制台q或CtrlC/CtrlD退出并关闭服务器配置项.vitepress/config或相关依赖文件变更时服务器会自动重启见 plugin.ts 的hotUpdate处理。vitepress build构建生产版本执行生产环境构建产出可直接部署的静态站点。用法vitepress build [root]选项选项说明--mpa实验性以 MPA 模式 构建无客户端激活boolean。开启后每个页面独立加载需在.vitepress/config中同时设置mpa: true以获得完整效果--base pathpublic base URL默认值/string。构建时传入会被normalizeSiteBase规范化src/node/build/build.ts例如--base /docs/--target target转译目标默认值modulesstring透传给底层打包器--outDir dir输出目录默认值.vitepress/diststring。CLI 传入的路径会以process.cwd()为基准解析为绝对路径src/node/build/build.ts--assetsInlineLimit number静态资源 base64 内联阈值字节默认值4096number。小于该值的资源会以内联形式嵌入产物构建流程构建入口 build 的执行步骤为设置NODE_ENV production并解析站点配置依次处理--base、--assetsBase、--mpa、--outDir等命令行覆盖项并行构建客户端与服务端SSRbundlebuilding client server bundles逐页渲染 HTMLrendering pages并清理临时目录若配置了sitemap.hostname最后生成sitemap.xml见 generateSitemap.ts。输出目录由 config.ts 解析默认outDir为root/dist即.vitepress/dist静态资源子目录assetsDir默认assets且assetsDir不允许超出outDir范围。vitepress preview本地预览生产版本在本地启动一个静态服务器预览vitepress build的产物用于上线前检查最终效果。用法vitepress preview [root]preview与serve是同一命令的两种写法二者在 src/node/cli.ts 中共同路由到 serve。选项选项说明--base pathpublic base URL默认值/string--port port指定端口number默认4173实现要点预览服务器基于polka sirv实现src/node/serve/serve.ts关键行为包括默认端口为 4173src/node/serve/serve.ts读取outDir下的静态产物对带指纹的静态资源设置immutable长缓存对不带指纹的 HTML 等文件设置no-cache强制校验src/node/serve/serve.ts相对 baseisRelativeBase统一在根路径提供服务绝对 URL base 则取其 pathnamesrc/node/serve/serve.ts未匹配路径回落到构建产物中的404.htmlsrc/node/serve/serve.ts可据此验证自定义 404 页面。vitepress init交互式安装向导在当前目录启动交互式向导快速初始化 VitePress 站点。用法vitepress init向导步骤向导基于clack/prompts实现init.ts依次询问配置初始化目录默认./Markdown 源文件目录默认与根目录相同站点标题默认My Awesome Project站点描述默认A VitePress Site主题类型Default Theme开箱即用的默认主题Default Theme Customization额外生成自定义 CSS 与布局插槽Custom Theme生成完整自定义主题骨架含Layout.vue是否使用 TypeScript 编写配置与主题文件是否向package.json注入 npm scriptsdev/build/preview是否给脚本添加前缀默认前缀docs即生成docs:dev等。生成的脚手架文件因主题类型而异init.ts默认主题生成index.md、api-examples.md、markdown-examples.md与.vitepress/config.js选择自定义主题还会追加.vitepress/theme/index.js、style.css与Layout.vue。若package.json中缺少vue依赖且选择了自定义主题向导会提示显式安装vue如果检测到.git目录还会提醒将.vitepress/dist与.vitepress/cache加入.gitignoreinit.ts。向导结束后会打印下一步命令例如npm run docs:dev注入脚本时或npx vitepress dev未注入脚本时。常见组合工作流将上述命令串联起来便是一条完整的文档站点生命周期# 1. 初始化站点仅首次 vitepress init # 2. 本地开发 vitepress dev docs # 或 npm run docs:dev # 3. 构建生产产物 vitepress build docs # 输出到 docs/.vitepress/dist # 4. 本地验证产物 vitepress preview docs --port 8080 # 5. 部署时指定 base 与输出目录 vitepress build docs --base /my-site/ --outDir ./public如果构建或启动过程中出现错误CLI 会通过logErrorAndExit打印错误信息并以非零状态码退出src/node/cli.ts对于未知命令同样会报错退出src/node/cli.ts。相关文档与源码索引命令官方参考docs/zh/reference/cli.md另有 英文版 及 es/fa/ja/ko/pt/ru/zh 多语言版本CLI 入口与命令分发src/node/cli.ts开发服务器创建src/node/server.ts生产构建主流程src/node/build/build.ts预览服务器实现src/node/serve/serve.ts安装向导实现src/node/init/init.ts终端快捷键src/node/shortcuts.tsMPA 模式指南docs/zh/guide/mpa-mode.md快速上手含安装向导说明docs/zh/guide/getting-started.md赞分享前端文档【免费下载链接】vitepressVite Vue powered static site generator.项目地址https://gitcode.com/gh_mirrors/vi/vitepress点击查看免费下载相关推荐VuePress 命令行接口CLI完全指南dev、build、eject 与自定义命令实战VuePress 命令行接口CLI完全指南dev、build、eject 与自定义命令实战 本文档系统讲解 VuePress 的命令行接口CLI覆盖前端文档SSRWails CLI工具完全指南init、build、dev命令详解Wails CLI工具完全指南init、build、dev命令详解 Wails是一个强大的Go框架用于使用Web技术构建跨平台桌面应用程序。本文将深入解析W桌面应用跨平台CLI前端Nitro CLI 完全指南dev / build / preview / deploy / task / docs 命令详解Nitro CLI 完全指南dev / build / preview / deploy / task / docs 命令详解 Nitro 随项目自带一个 n后端Web框架SSR上一篇任天堂Switch模拟器调试终极指南GDB与LLDB在yuzu核心模块的高效使用下一篇如何用Penpot实现完美移动适配响应式设计与移动端优化全指南创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

相关推荐

Atlas 300V 24G推理卡部署YOLO实战:从模型转换到性能调优全指南
Atlas 300V 24G推理卡部署YOLO实战:从模型转换到性能调优全指南

我这段时间一直在折腾一块 Atlas 300V 24G 推理卡,起因其实很朴素:手头有几路视频分析业务,需要低功耗、高吞吐的推理方案,对比了一圈之后发现这块卡在视频解码和 INT8 算力上的性价比确实能打。但真正插上服务器开始部署 YOLO 的… · 2026/9/21 2:15:46

基于BiLSTM的轴承剩余寿命预测及MATLAB GUI实现
基于BiLSTM的轴承剩余寿命预测及MATLAB GUI实现

简介:一套基于MATLAB的BiLSTM轴承剩余寿命预测实战项目,面向具备编程基础、从事故障诊断与预测性维护的科研人员和工程师。项目围绕振动信号采集、预处理、滑动窗口序列构建、BiLSTM回归建模及评估可视化展开,覆盖从数据构造到GUI交互部署的完… · 2026/9/21 2:15:46

RxJS v4 `share()` 操作符完全指南:基于 `publish().refCount()` 实现多订阅者共享单一底层订阅
RxJS v4 `share()` 操作符完全指南:基于 `publish().refCount()` 实现多订阅者共享单一底层订阅

后端 【免费下载链接】RxJS The Reactive Extensions for JavaScript 项目地址: https://gitcode.com/gh_mirrors/rxj/RxJS 点击查看 免费下载 Rx.Observable.prototype.share() 是 Reactive Extensions for JavaScript(RxJS v4)中用于解决&… · 2026/9/21 2:15:46

一个服务器上有两个网站要备案两次吗速查手册
一个服务器上有两个网站要备案两次吗速查手册

一个服务器上有两个网站要备案两次吗速查手册 改个需求建站公司拖一周,这种憋屈事儿我见得太多了。作为湖北创业团队的负责人,我最怕的就是因为搞不清技术细节,让外包团队有借口拖延进度。其实,很多所谓的“技术难题”,往往只是信息不对称造成的误解。今天我就把这份关于 一个服务器上有两个网站要备案两次吗 的… · 2026/9/21 9:32:45

单位网络建设的设计方案全流程解析避坑指南
单位网络建设的设计方案全流程解析避坑指南

单位网络建设的设计方案全流程解析避坑指南 改个需求建站公司拖一周,这种痛谁懂?很多单位搞网络建设,前期方案写得漂漂亮亮,后期落地全是坑。别急着怪供应商,大概率是你们的【单位网络建设的设计方案】里,把【完整流程】搞丢了,或者干脆没搞。… · 2026/9/21 9:17:55

3个实战案例教你挑对软件下载网站哪个好防挂马
3个实战案例教你挑对软件下载网站哪个好防挂马

3个实战案例教你挑对软件下载网站哪个好防挂马 上周帮客户复盘,发现官网弹窗全是博彩广告,后台日志被清空,这种被黑挂马的恐惧,很多站长都经历过。 别慌,选对底层架构的下载站,比事后打补丁重要十倍。 结合3个被黑过的实战案例,我拆解一下“软件下载网站哪个好”的评判标准。 设计原则与信任感构建… · 2026/9/21 9:02:23

网站标识代码怎么加实操详解及对比评测避坑指南
网站标识代码怎么加实操详解及对比评测避坑指南

网站标识代码怎么加实操详解及对比评测避坑指南 备案流程一头雾水,是很多中小企业在上线官网时最容易卡壳的环节。很多老板以为只要把网站做出来,挂上域名就能收流量,结果发现没ICP备案根本打不开,或者加了备案代码位置不对导致审核不通过。这时候,一份清晰的网站标识代码怎么加的操作指南,加上不同服务商方案的对… · 2026/9/21 8:45:49

别被网页制作模板中文坑了,懂建站报价才不亏
别被网页制作模板中文坑了,懂建站报价才不亏

别被网页制作模板中文坑了,懂建站报价才不亏 网站做好了没人访问,这钱白花得冤不冤?很多老板找外包,问完建站报价,对方甩给你一个“网页制作模板中文”链接,说这是高端定制。你一看,哦,是套壳的。更坑的是,有些模板连基础的SEO结构都没做好,上线三个月,百度搜不到你公司名字。… · 2026/9/21 8:31:34

2026最新微信小程序连接wordpress:解决域名服务器搞不懂的实战指南
2026最新微信小程序连接wordpress:解决域名服务器搞不懂的实战指南

2026最新微信小程序连接wordpress:解决域名服务器搞不懂的实战指南 域名解析指向不对,服务器端口没开放,SSL证书配置报错——这三座大山,劝退了一半想用微信小程序展示WordPress内容的开发者。别急,2026最新的连接方案早已绕开了传统Web服务器配置的深坑,核心逻辑是:… · 2026/9/21 8:17:36

Flutter for OpenHarmony游戏卡片渐变背景实战:从原理到性能优化
Flutter for OpenHarmony游戏卡片渐变背景实战:从原理到性能优化

直接铺开项目本身吧。这几个月我一直在折腾一件事:用Flutter给OpenHarmony做一款游戏集合类的App,说白了就是把若干小游戏塞进一个壳里,用统一入口分发。这个方向本身不算新鲜,真正让我花了不少心思的,是首页那堆游戏卡… · 2026/9/21 0:02:39

Word表格编号全攻略:从列表编号到题注交叉引用
Word表格编号全攻略:从列表编号到题注交叉引用

写Word文档,最让人头疼的往往是那些“看起来不起眼”的小问题。比如表格编号这事:今天在表后面多加了两个空白行,明天给客户交稿前发现整个章节的编号全部错位,光是挨个改序号就能耗掉大半个下午。我前阵子帮人整理一份上百页的技… · 2026/9/21 0:02:39

从第一个站到第二个站:独立开发者的静态网站选型与落地实践
从第一个站到第二个站:独立开发者的静态网站选型与落地实践

1. 项目概述1.1 核心需求解析做独立开发者这几年,说实话,第一个网站上线的那天晚上我兴奋得没睡着。但等它跑了半年,流量惨淡、功能臃肿、代码自己都懒得看第二遍之后,我才慢慢琢磨明白一个道理:第一个网站是练手&… · 2026/9/20 0:00:41

Claude Code 按智谱AI指南装完,ANTHROPIC_BASE_URL 改走 TaoToken 兼容通道行不行
Claude Code 按智谱AI指南装完,ANTHROPIC_BASE_URL 改走 TaoToken 兼容通道行不行

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views … · 2026/9/21 0:00:18

agents-generator 决策矩阵全解析:从项目检测到 AGENTS.md 规则生成的 16 步判定流程
agents-generator 决策矩阵全解析:从项目检测到 AGENTS.md 规则生成的 16 步判定流程

agents-generator 决策矩阵全解析:从项目检测到 AGENTS.md 规则生成的 16 步判定流程 【免费下载链接】agentic-awesome-skills AAS Core is the local, agent-first control plane for complete catalog discovery, agent-owned selection, stack validation, and … · 2026/9/21 0:00:18

gin-vue-admin 前端工具函数全景指南:src/utils 复用规范与源码级解析
gin-vue-admin 前端工具函数全景指南:src/utils 复用规范与源码级解析

gin-vue-admin 前端工具函数全景指南:src/utils 复用规范与源码级解析 【免费下载链接】gin-vue-admin 🚀ViteVue3Gin拥有AI辅助的基础开发平台,企业级业务AI开发解决方案,内置mcp辅助服务,内置skills管理,… · 2026/9/21 0:00:18

了解更多?预约专属演示

我们的顾问将为您一对一讲解产品与方案

企业微信二维码