SuperAPI AI 工具集

docs-site

部署与运维

查看项目

更新于 10-16 09:49

技能介绍

用途:在 GitHub Pages 上正确搭建、部署或修复文档站点,避免首次部署就出现 404、样式丢失等常见问题。不负责撰写文档内容(→docs-author)、README(→readme-author)、分支保护(→repo-protections)、仓库可发现性(→repo-discoverability);不涉及 Read the Docs、Netlify、Vercel 或应用部署。

主要能力与工作流:

  1. 检查生态、语言、现有 docs 配置与 workflows、gh-pages 分支及 Pages 状态(gh api repos/{owner}/{repo}/pages),不推翻可用的生成器。
  2. 按 references/generator-choice.md 依据生态与需求选择生成器;若导航需求低于阈值,建议仅保留 README 并停止。
  3. 先配置 base path:项目站点在 /<repo>/ 下服务,按 references/pages-deploy.md 设置 site_url/baseUrl/base;开启严格构建(mkdocs build --strict、sphinx-build -W)。
  4. 只选一种部署模型:版本化 MkDocs 用 mike 发布到 gh-pages(含 .nojekyll 与别名,如 mike deploy X latest --update-aliases、mike set-default latest);其余用官方 artifact 工作流(configure-pages → 严格构建 → upload-pages-artifact,再 deploy-pages),权限 pages: write 与 id-token: write,仅从默认分支部署。
  5. 切换 Pages 源为 GitHub Actions(Settings → Pages → Source,或 gh api repos/{owner}/{repo}/pages -X POST -f build_type=workflow;已存在则 -X PUT)。
  6. 线上验证 page_url 的样式与深层链接。
  7. Docs CI:PR 上严格构建加内部链接检查并阻断;外部链接每周定时、非阻断。
  8. 可选:自定义域名、版本化、llms.txt(按价值排序)。
  9. 运行 python3 "${CLAUDE_SKILL_DIR}/scripts/check_pages_setup.py" 并修复报告问题。

适用场景:需要一键上线可正常访问、有样式和可用深层链接的文档站。

限制与常见问题:workflow 变绿但站点 404 多为 Pages 源未设为 GitHub Actions;本地正常但 github.io 异常多为 base path 问题;.nojekyll 仅对分支发布必要;自定义域名需先验证 TXT 再配 DNS;分支模式构建不会被 GITHUB_TOKEN 推送的提交触发;隐藏文件(如 .well-known/)默认被排除;私有仓库的 Pages 站点也是公开的;旧版 Pages actions 会直接失败。缺失信息:具体版本号与价格暂未提供。