LoveChengke
19c2aa07b2
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
86 lines
2.9 KiB
YAML
86 lines
2.9 KiB
YAML
name: 发布文档站
|
||
|
||
# 把 docs/ 用 docfx 构建成静态站点，部署到 GitHub Pages。
|
||
#
|
||
# 为什么单独一个 workflow：
|
||
# docfx 是 .NET 工具（`dotnet tool install -g docfx`），需要在 CI 里装 .NET SDK；
|
||
# 而文档站与三个交付物的发布节奏也完全不一样 —— 改一个错别字就该上线，
|
||
# 不该为此打个安装包、发个 Release。
|
||
#
|
||
# 站点地址：https://lovechengke.github.io/ClassHelper/
|
||
# 需要在仓库 Settings → Pages 里把 Source 选成「GitHub Actions」（只需做一次）。
|
||
#
|
||
# 本地预览：pnpm docs:serve
|
||
|
||
on:
|
||
push:
|
||
branches: [master]
|
||
paths:
|
||
# 文档内容与构建脚本
|
||
- 'docs/**'
|
||
- '.github/workflows/docs.yml'
|
||
# 顶栏那个版本徽标取自根 package.json（docs/build.mjs 通过 --metadata 注入），
|
||
# 所以版本号变了也要重新发一次文档站
|
||
- 'package.json'
|
||
workflow_dispatch:
|
||
|
||
# Pages 部署需要的三件套：读代码、写 Pages、用 OIDC 拿部署令牌
|
||
permissions:
|
||
contents: read
|
||
pages: write
|
||
id-token: write
|
||
|
||
# 同一时间只跑一个部署；已经在跑的那次不取消（半途取消会留下一个坏掉的站点）
|
||
concurrency:
|
||
group: pages
|
||
cancel-in-progress: false
|
||
|
||
jobs:
|
||
build:
|
||
runs-on: ubuntu-latest
|
||
timeout-minutes: 20
|
||
steps:
|
||
- name: 检出代码
|
||
uses: actions/checkout@v4
|
||
|
||
- name: 安装 .NET SDK 8
|
||
uses: actions/setup-dotnet@v4
|
||
with:
|
||
dotnet-version: '8.0.x'
|
||
|
||
- name: 安装 docfx
|
||
# docfx 是 .NET 全局工具，装完在 ~/.dotnet/tools 下；setup-dotnet 会把它加进 PATH，
|
||
# 这里再显式补一次，免得换 runner 镜像后找不到命令。
|
||
run: |
|
||
dotnet tool install --global docfx
|
||
echo "$HOME/.dotnet/tools" >> "$GITHUB_PATH"
|
||
|
||
- name: 构建文档站
|
||
# --check 把 docfx 的警告当错误：最常见的警告是"某个 .md 没被任何 toc.yml 引用"，
|
||
# 那种页面会被构建出来但没有侧边栏 —— 属于必须修掉的疏漏，不该悄悄上线。
|
||
#
|
||
# DOCS_BASE 是给 404 页用的：项目页挂在 /<仓库名>/ 子路径下，而浏览器按**被请求的路径**
|
||
# 解析 404 页里的相对链接，所以要把站点根钉成 <base>。这里从仓库名算，改仓库名不用改脚本。
|
||
env:
|
||
DOCS_BASE: /${{ github.event.repository.name }}/
|
||
run: node docs/build.mjs --check
|
||
|
||
- name: 配置 Pages
|
||
uses: actions/configure-pages@v5
|
||
|
||
- name: 上传构建产物
|
||
uses: actions/upload-pages-artifact@v3
|
||
with:
|
||
path: docs/_site
|
||
|
||
deploy:
|
||
needs: build
|
||
runs-on: ubuntu-latest
|
||
environment:
|
||
name: github-pages
|
||
url: ${{ steps.deployment.outputs.page_url }}
|
||
steps:
|
||
- name: 部署到 GitHub Pages
|
||
id: deployment
|
||
uses: actions/deploy-pages@v4
|