快速开始
docdoc 本体的本地开发环境与验证闭环。环境要求:Node.js 20+、pnpm 12+。
工作区准备
克隆仓库后在根目录:
pnpm install
pnpm build
构建由 Turborepo 编排,CLI 产物为 clis/docdoc/dist/index.js(带 shebang,可直接执行)。
CLI 版本号在构建期注入(vite.config.ts 的 define 替换 __DOCDOC_VERSION__):构建时 HEAD 带 vXXX 标签取标签号(去 v 前缀),否则取当前提交短哈希;非 git 环境回退 package.json 的 version。
常用任务
| 命令 | 作用 |
|---|---|
pnpm build(根目录) |
全量构建所有子项目 |
pnpm typecheck |
全量类型检查 |
pnpm dev / nitrogen dev |
交互式选择子项目启动 dev 任务 |
本地验证
以仓库自带的 docs/ 站点为 dogfood 源:
node clis/docdoc/dist/index.js build docs --output /tmp/site
node clis/docdoc/dist/index.js preview docs --port 10002
修改渲染管线、模板或客户端资源后重新构建并刷新预览即可核对页面效果。CLI 各命令的完整参数见用户手册的命令参考,站点模型与管线机制见架构章。
