name: docusaurus-deployer version: 1.2 description: 此技能应用于将Docusaurus站点部署到GitHub Pages时。它自动化了配置、构建和部署过程,处理GitHub Pages设置、环境配置和CI/CD自动化。包括在触发GitHub Actions之前的本地验证。 constitution_alignment: v4.0.1
Docusaurus GitHub Pages 部署器
自动化构建Docusaurus文档站点并将其部署到GitHub Pages,在触发CI/CD之前进行本地验证。
宪法对齐:此技能实现了宪法v4.0.1(第I部分第9支柱:通用云原生部署)中定义的生产部署标准。所有部署在发布前必须满足项目质量门禁。
此技能的功能
- 项目分析 - 检查Docusaurus结构和依赖项
- 本地配置验证 - 验证Docusaurus配置和侧边栏
- 本地构建与测试 - 本地构建站点并验证输出
- 内容验证 - 检查损坏的链接和语法错误
- GitHub Pages 设置 - 配置仓库和部署设置
- CI/CD 自动化 - 设置GitHub Actions工作流
- 部署验证 - 验证部署是否成功
何时使用此技能
在以下情况下将Docusaurus部署到GitHub Pages:
- 首次设置文档部署时
- 发布前更新文档时
- 更新部署配置时
- 排查部署问题时
- 管理多个文档站点时
- 确保生产环境文档质量时
如何使用此技能
遵循 本地验证然后发布 的工作流程:
步骤 1:准备仓库配置
收集GitHub组织/用户名、仓库名称、部署目标(用户/项目页面)和自定义域名(可选)。
步骤 2:分析项目结构
检查Docusaurus项目:
ls -la path_to_docusaurus_project/
cat path_to_docusaurus_project/docusaurus.config.ts
cat path_to_docusaurus_project/sidebars.ts
验证docusaurus.config.ts、sidebars.js/ts、package.json engines字段和依赖项是否存在。
有关详细配置指南,请参阅 references/configuration-guide.md。
步骤 3:更新Docusaurus配置
使用GitHub Pages设置更新 docusaurus.config.ts。根据部署目标(用户页面与项目页面),请参阅 references/configuration-guide.md 获取完整的配置示例和指南。
步骤 4:本地构建与验证
安装依赖项,运行类型检查,构建站点,验证输出,本地测试,并验证内容质量。
执行:
npm ci
npm run typecheck
npm run build
npm run serve
有关详细验证程序,请参阅 references/local-validation-guide.md。
步骤 5:提交并推送到主分支
本地验证成功后:
git add .
git commit -m "更新文档:[描述]"
git push origin main
这将触发GitHub Actions工作流。
步骤 6:设置GitHub Actions
使用 references/deploy-workflow.yml 中的模板创建 .github/workflows/deploy.yml。
有关详细的工作流配置和故障排除,请参阅 references/github-actions-guide.md。
步骤 7:在仓库设置中配置GitHub Pages
- 前往 设置 → Pages
- 将源设置为 GitHub Actions(或从
gh-pages分支部署) - 根据需要配置自定义域名
- 在主分支上启用分支保护
步骤 8:验证部署
在Actions选项卡中检查GitHub Actions工作流状态,验证站点在配置的URL上是否加载,并确认所有导航功能正常。
故障排除
有关常见问题和解决方案,请参阅 references/troubleshooting.md,其中涵盖:
- 构建失败和类型错误
- 部署后出现404错误
- 损坏的链接和GitHub Actions问题
- 性能问题和内容质量
捆绑资源
references/deploy-workflow.yml- GitHub Actions工作流模板references/configuration-guide.md- 详细的Docusaurus配置references/local-validation-guide.md- 构建和验证程序references/github-actions-guide.md- CI/CD设置和配置references/troubleshooting.md- 常见问题和解决方案references/performance-standards.md- 性能目标和最佳实践
性能目标
- 构建时间:< 30秒(典型)
- 页面加载:< 3秒
- 包大小:针对文档优化
- 可访问性:符合WCAG 2.1 AA标准
质量门禁 (宪法 v3.1.2)
在部署到生产环境之前,请验证:
- [ ] 所有内容通过验证审计器验证
- [ ] 本地构建完成且无错误
- [ ] 无损坏链接或缺失资源
- [ ] TypeScript类型检查通过
- [ ] 达到性能目标
- [ ] 已验证可访问性标准
- [ ] GitHub Actions工作流配置正确
参考:有关完整的生产部署标准,请参阅 .specify/memory/constitution.md 部署标准部分。
使用的工具
- Node.js/npm (v20+)
- Docusaurus CLI
- TypeScript
- GitHub Actions
- GitHub Pages