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`。
61 lines
3.5 KiB
JSON
61 lines
3.5 KiB
JSON
{
|
|
"name": "class-helper",
|
|
"version": "1.1.2",
|
|
"private": true,
|
|
"description": "班级小助手 - 班级信息管理系统（Web 管理端 + 后端服务 + 桌面客户端）",
|
|
"packageManager": "pnpm@11.8.0",
|
|
"engines": {
|
|
"node": ">=20.19.0"
|
|
},
|
|
"scripts": {
|
|
"build:shared": "pnpm --filter @classhelper/shared build",
|
|
"dev": "pnpm build:shared && concurrently -k -n shared,server,web -c cyan,green,magenta \"pnpm --filter @classhelper/shared dev\" \"pnpm --filter @classhelper/server dev\" \"pnpm --filter @classhelper/web-admin dev\"",
|
|
"dev:server": "pnpm build:shared && pnpm --filter @classhelper/server dev",
|
|
"dev:web": "pnpm build:shared && pnpm --filter @classhelper/web-admin dev",
|
|
"dev:desktop": "pnpm build:shared && pnpm --filter @classhelper/desktop-client dev",
|
|
"build": "pnpm build:shared && pnpm --filter @classhelper/server build && pnpm --filter @classhelper/web-admin build && pnpm --filter @classhelper/desktop-client build",
|
|
"build:desktop": "pnpm build:shared && pnpm --filter @classhelper/desktop-client build",
|
|
"build:classisland-plugin": "node packages/classisland-plugin/scripts/build.mjs",
|
|
"check:icons": "node scripts/check-icons.mjs",
|
|
"typecheck": "pnpm build:shared && pnpm -r --no-bail typecheck",
|
|
"lint": "eslint .",
|
|
"lint:fix": "eslint . --fix",
|
|
"format": "prettier --write \"**/*.{ts,js,mjs,cjs,vue,json,md,yaml,yml,css,scss,html}\"",
|
|
"format:check": "prettier --check \"**/*.{ts,js,mjs,cjs,vue,json,md,yaml,yml,css,scss,html}\"",
|
|
"db:generate": "pnpm --filter @classhelper/server db:generate",
|
|
"db:migrate": "pnpm --filter @classhelper/server db:migrate",
|
|
"db:seed": "pnpm --filter @classhelper/server db:seed",
|
|
"db:reset": "pnpm --filter @classhelper/server db:reset",
|
|
"db:studio": "pnpm --filter @classhelper/server db:studio",
|
|
"db:switch:mysql": "node scripts/use-database.mjs mysql",
|
|
"db:switch:sqlite": "node scripts/use-database.mjs sqlite",
|
|
"verify:e2e": "pnpm --filter @classhelper/server verify:e2e",
|
|
"verify:desktop": "pnpm --filter @classhelper/desktop-client smoke",
|
|
"verify:web": "node scripts/ui-smoke/run.mjs",
|
|
"verify:packaged": "node scripts/verify-packaged.mjs",
|
|
"verify:classisland": "pnpm --filter @classhelper/server verify:classisland",
|
|
"verify:classisland-plugin": "node packages/classisland-plugin/scripts/verify.mjs",
|
|
"icons": "node scripts/generate-icons.mjs",
|
|
"version:check": "node scripts/version.mjs",
|
|
"version:bump": "node scripts/version.mjs --bump",
|
|
"docs:build": "node docs/build.mjs",
|
|
"docs:serve": "node docs/build.mjs --serve",
|
|
"docs:check": "node docs/build.mjs --check",
|
|
"dist:win": "pnpm --filter @classhelper/desktop-client dist:win",
|
|
"dist:dir": "pnpm --filter @classhelper/desktop-client dist:dir",
|
|
"dist:server": "pnpm build:shared && pnpm --filter @classhelper/server build && pnpm --filter @classhelper/web-admin build && node scripts/dist-server.mjs",
|
|
"dist:server:linux": "pnpm build:shared && pnpm --filter @classhelper/server build && pnpm --filter @classhelper/web-admin build && node scripts/dist-server.mjs --platform linux",
|
|
"dist:classisland-plugin": "node packages/classisland-plugin/scripts/build.mjs --cipx",
|
|
"dist:all": "pnpm dist:server && pnpm dist:win && pnpm dist:classisland-plugin"
|
|
},
|
|
"devDependencies": {
|
|
"concurrently": "^10.0.5",
|
|
"eslint": "^10.10.0",
|
|
"eslint-plugin-vue": "^10.11.0",
|
|
"prettier": "^3.9.6",
|
|
"typescript": "~5.9.3",
|
|
"typescript-eslint": "^8.70.0",
|
|
"vue-eslint-parser": "^10.4.1"
|
|
}
|
|
}
|