用途:该技能面向 Docusaurus 文档站点的 GitHub Pages 部署,覆盖从项目分析到上线验证的完整流程。
主要能力:分析 Docusaurus 结构与依赖;校验本地配置与 sidebars;本地构建并检查输出;检查断链与语法错误;配置仓库与部署设置;建立 GitHub Actions 工作流;验证部署结果。
使用方式:先在本地运行 npm run build 确认无错误并输出到 build/;在 docusaurus.config.js(或 .ts)中设置 url(如 https://<github-username>.github.io)、baseUrl(如 "/<repo-name>/")、organizationName、projectName、deploymentBranch(通常 gh-pages);编辑 sidebars.js 组织章节结构;用 npm run start 本地预览。随后用 GitHub CLI 初始化并推送仓库,如 gh repo create <repo> --public;若 Pages 未启用,运行 gh pages enable --branch gh-pages。在 .github/workflows/deploy.yml 中配置工作流,使用 actions/checkout、actions/setup-node(node-version '18')、npm ci、npm run build,并通过 peaceiris/actions-gh-pages@v3 将 ./build 发布到 gh-pages 分支。提交推送后由 Actions 自动部署,站点地址为 https://<username>.github.io/<repo>/。
适用场景:需要把 Docusaurus 课程或项目文档发布到 GitHub Pages,并希望以 CI/CD 自动更新。
限制与注意:避免硬编码敏感信息,改用环境变量或 GitHub Secrets;部署失败时检查 baseUrl 等配置;资料未提供具体收费、价格或平台支持范围。