| 目录 | 内容 |
|---|---|
guide/ |
使用手册:安装、消息、联系人、导出、空间邮箱、分析与工具、设置 |
database/ |
QQNT 本地数据库表结构与字段 |
tools/ |
在线工具箱:头像路径、数据库密钥、商城表情等纯前端计算器 |
develop/ |
开发向常青内容:协议、架构、踩坑记录、原理 |
notes/ |
过程记录(不进站点,见 notes/README.md) |
pnpm install
pnpm dev # http://127.0.0.1:5174
pnpm check # 只跑链接完整性检查
pnpm build # 先 check 再构建,产物在 .vitepress/dist文档站使用独立的 pnpm-workspace.yaml、锁文件与依赖目录,不加入 WeQ 的应用 workspace。
在 WeQ 主仓根目录可运行 pnpm docs:install 安装文档依赖,再用 pnpm docs:dev、
pnpm docs:check、pnpm docs:build 或 pnpm docs:preview 转调本站命令。
仅开发应用时仍运行 pnpm dev,不需要安装文档站依赖。
「支持的 QQ 版本」页读 versions/supported.json 与 versions/latest.json。这两个文件
不入库 —— 权威数据在主仓 versions/,由 .github/workflows/qq-version-watch.yml
每晚更新。
- CI 构建前自动从主仓拉取到
versions/; - 本地开发设
WEQ_VERSIONS_DIR=/path/to/WeQ/versions指过去即可。
它是 WeQ 的 docs/ 目录(submodule)。改文档时:
- 直接在主仓的
docs/里改,提交会同时更新 submodule 指针; - 或者在本仓库单独提交,再回主仓提交指针更新。
跨目录引用(源码、CONTRIBUTING.md、CHANGELOG.md)一律写 GitHub 绝对 URL ——
check-docs.mjs 会检查这一点,因为相对路径在独立 checkout 下必然 404。