DocusaurusGitHubPagesDeployerSkill docusaurus-deployer

自动化部署Docusaurus文档站点到GitHub Pages,包括本地验证和CI/CD自动化

DevOps 0 次安装 0 次浏览 更新于 2/28/2026

name: docusaurus-deployer version: 1.2 description: 这个技能应该在部署Docusaurus站点到GitHub Pages时使用。它自动化了配置、构建和部署流程,处理GitHub Pages设置、环境配置和CI/CD自动化。包括在CI/CD触发前进行本地验证。 constitution_alignment: v4.0.1

Docusaurus GitHub Pages Deployer

自动化构建和部署Docusaurus文档站点到GitHub Pages,并在CI/CD触发前进行本地验证。

宪法对齐:这个技能实现了宪法v4.0.1(第I节第9节:通用云原生部署)中定义的生产部署标准。所有部署必须在发布前满足项目质量门。

这个技能做什么

  1. 项目分析 - 检查Docusaurus结构和依赖
  2. 本地配置验证 - 验证Docusaurus配置和侧边栏
  3. 本地构建与测试 - 本地构建站点并验证输出
  4. 内容验证 - 检查断开的链接和语法错误
  5. GitHub Pages设置 - 配置仓库和部署设置
  6. CI/CD自动化 - 设置GitHub Actions工作流
  7. 部署验证 - 验证成功部署

何时使用这个技能

当:

  • 第一次设置文档部署
  • 发布前更新文档
  • 更新部署配置
  • 排查部署问题
  • 管理多个文档站点
  • 在生产前确保文档质量

如何使用这个技能

遵循本地验证然后发布工作流程:

第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引擎字段,以及依赖项是否存在。

有关详细配置指导,请参阅references/configuration-guide.md

第3步:更新Docusaurus配置

更新docusaurus.config.ts为GitHub Pages设置。根据部署目标(用户vs.项目页面),请参阅references/configuration-guide.md中的完整配置示例和指南。

第4步:本地构建和验证

安装依赖项,运行类型检查,构建站点,验证输出,本地测试,并验证内容质量。

执行:

npm ci
npm run typecheck
npm run build
npm run serve

有关详细验证程序,请参阅references/local-validation-guide.md

第5步:提交并推送到Main

在本地验证成功后:

git add .
git commit -m "Update documentation: [description]"
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

  1. 转到设置 → 页面
  2. 设置源为GitHub Actions(或从gh-pages分支部署)
  3. 如有需要,配置自定义域名
  4. 在主分支上启用分支保护

第8步:验证部署

检查GitHub Actions工作流状态在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