DOCC Frontend

frontend-web 是文档中心的文档内容站点，负责承载帮助文档、章节导航、静态资源以及 PDF 导出能力。

重要说明

代码更新后，必须执行 deploy 命令将内容同步到私有仓。

原因：

• CI 构建拿的是私有仓代码
• 如果只修改当前仓库但没有执行 deploy，CI 不会拿到最新文档内容
• 这会直接导致线上构建结果和当前提交不一致

必须执行：

npm run deploy

这条要求非常重要，更新文档内容、配置或构建逻辑后，都需要确认已执行同步。

项目定位

frontend-web 是文档中心前台文档站，主要负责：

• 产品文档展示
• 文档章节组织
• 站点导航与页面渲染
• PDF 导出
• 站点构建与部署同步

仓库内相关项目分工如下：

• frontend-web：文档内容站
• homepage-web：门户首页
• backend-web：后台管理端

技术栈

• VuePress 1.9.7
• Node.js
• Markdown
• Puppeteer
• Ant Design Vue

环境要求

• Node.js
• npm

建议结合仓库根目录中的环境说明，使用 fnm 管理 Node 版本。

目录结构

frontend-web/
├── .vuepress/          # VuePress 配置、主题、组件、插件和公共资源
├── build/              # 构建前后处理及部署脚本
├── pdf/                # PDF 导出脚本
├── test/               # 测试或校验相关内容
├── zh/                 # 中文文档内容
├── dist/               # 构建产物
├── package.json
└── README.md

文档内容

当前文档内容主要维护在 zh/ 目录下，按主题拆分，例如：

• 产品描述
• 安装与升级
• 版本说明
• 导入和导出
• 数据源管理
• 文件管理
• 系统设置
• AI助手
• SQL开发

.vuepress/ 目录用于维护站点配置、导航、主题样式和组件扩展。

常用命令

安装依赖

npm install

本地开发

npm run dev

清理缓存后启动

npm run dev:clean

生产构建

npm run build

导出 PDF

可参考 pdf/README

npm run export-pdf

同步私有仓

npm run deploy

构建说明

build 命令实际执行流程如下：

node ./build/prev.mjs
vuepress build .
node ./build/prod.mjs

说明：

• build/prev.mjs：构建前处理
• vuepress build .：执行站点构建
• build/prod.mjs：构建后处理

发布要求

文档更新后的推荐流程：

npm install
npm run build
npm run deploy

其中 npm run deploy 不是可选步骤，而是发布链路中的必需步骤。

发布注意事项

• 只执行 build 不代表 CI 能获取最新内容
• CI 使用的是私有仓，不是当前工作仓
• 因此文档、配置、脚本有更新时，必须执行 deploy
• 提交代码前应确认私有仓同步已经完成

相关文件

• .vuepress/config.js：站点主配置
• build/deploy.mjs：私有仓同步脚本
• build/prev.mjs：构建前处理脚本
• build/prod.mjs：构建后处理脚本
• pdf/export-pdf.mjs：PDF 导出脚本