跳到正文
参考资料/参考资料

长文档建议按当前分组逐页阅读；右侧辅助栏会保留当前位置和快速操作。

参考资料

参考资料

本页是源码到文档引用索引，把当前已经文档化的页面、组件、工具、平台后端、脚本和构建产物按 维护路径串起来。它的作用不是替代专题文档，而是让开发者从源码文件快速定位到对应说明。

已接入参考页面

Tauri API / HTTP Bridge

命令、桥接和 HTTP 调试入口。

开发规范

仓库约定、质量门禁和维护要求。

Nonebot / 外部集成

外部机器人、接口和联动说明。

实现札记

历史实现、设计取舍和细节备注。

入口与导航

src/main.ts

Vue 应用入口，初始化主题、设置、字体、后台任务、通知检查、调试日志和调试桥。

src/App.vue

主视图调度入口，维护 currentView、历史栈、返回行为、模块宿主会话和受保护页面访问。

website/src/App.tsx

文档站和下载站路由入口，注册所有 /docs 子路由和静态页面。

website/src/layouts/DocsLayout.tsx

文档导航、分组、侧栏和移动端菜单结构。

用户文档索引

QuickStart.tsx

快速开始：安装、首次登录、首页、搜索、快捷入口和返回行为。

UserGuide.tsx

用户手册：主导航、账号、会话、首页工作流和日常使用路径。

AcademicServices.tsx

教务服务：成绩、课表、考试、排名、空教室、培养方案和学业进度。

CampusLife.tsx

校园生活：电费、校园码、流水、图书馆、地图、资料分享和 AI。

CommunityNotifications.tsx

社区与通知：论坛、帖子、反馈、通知权限和后台提醒。

Extensions.tsx

扩展模块：更多页面、小游戏、模块宿主和远程模块体验。

SettingsData.tsx

设置与数据：主题、字体、导出、云同步、调试日志和反馈材料。

Troubleshooting.tsx

故障排查：安装、登录、缓存、通知、云同步、调试脚本和维护清单。

开发者文档索引

DeveloperOverview.tsx

开发者总览：入口层、视图调度、组件组织、平台边界和阅读顺序。

ArchitectureDataFlow.tsx

架构与数据流：请求、缓存、远程配置、云同步、通知、SQLite 和错误处理。

PlatformTauri.tsx

平台与 Tauri：运行时识别、PlatformBridge、Tauri/Capacitor/Web adapter、权限和 commands。

ModuleSystem.tsx

模块系统：模块中心、manifest、本地 bundle、Capacitor 缓存、构建发布和安全边界。

BuildRelease.tsx

构建发布：根构建、website 构建、release manifest、热更新包、模块产物和守卫脚本。

SecurityPrivacy.tsx

安全与隐私：账号、Cookie、SQLite、localStorage、远程内容、调试桥和热更新边界。

参考页索引

TauriApi.tsx

低频 API 与 HTTP Bridge 查阅入口。

DevRules.tsx

开发规范和工程约束。

Nonebot.tsx

外部集成参考。

Implementation.tsx

实现札记和历史说明。

旧版文档索引

这些页面仍在路由和静态入口中保留，适合查历史说明；新版用户文档、开发者文档、故障排查和参考索引是当前主线。

Guide.tsx

旧版安装指南，保留历史平台安装、下载和侧载说明。新版首次使用路径优先读 QuickStart.tsx。

Configuration.tsx

旧版配置说明，保留 OCR、远程配置、云同步和高级配置细节。新版用户路径优先读 SettingsData.tsx。

FAQ.tsx

旧版 FAQ，保留历史问答。新版排错闭环优先读 Troubleshooting.tsx。

Technical.tsx

旧版技术原理，保留历史架构解释。新版实现路径优先读 DeveloperOverview.tsx 和 ArchitectureDataFlow.tsx。

More.tsx

旧版更多资料入口，保留外部链接、贡献入口和相关资料。新版源码索引优先读 ReferenceIndex.tsx。

交叉阅读矩阵

索引与历史资料

/docs/reference/docs/faq

参考索引负责当前源码定位，旧版 FAQ 保留历史问答和迁移线索。

前端组件索引

Dashboard.vue

首页和搜索、今日课程、天气、快捷入口、功能分类、首页布局状态。

ScheduleView.vue

个人课表、自定义课程、学期/周次、导入导出、ICS 和云同步入口。

GradeView.vue

成绩查询、绩点、学分、缓存和登录失效提示。

MoreView.vue

模块中心、catalog 拉取、manifest 检查、模块准备和跳转。

MoreModuleHostView.vue

模块 iframe 宿主、本地/远程 preview_url、加载失败和外部打开兜底。

SettingsView.vue

设置、云同步状态、调试日志、测速、通知、字体、主题和实验选项。

FeedbackView.vue

反馈入口、复制最近 error、复制单条 error 和反馈链接。

工具与数据索引

src/utils/api.js

教务 API、fetchWithCache、withOfflineMeta、sync_time、维护标记和 localStorage 缓存。

src/utils/cloud_sync.js

云同步上传/下载、hbu_cloud_sync_status、cooldown、x-cloud-sync-challenge。

src/utils/module_center.js

DEFAULT_MODULE_CENTER、buildModuleCenterCards 和模块中心入口归一化。

src/utils/more_modules.js

远程 catalog、manifest、本地 bundle、Capacitor 文件缓存和 preview source 选择。

src/utils/notify_center.js

runNotificationCheck、hbu_notify_snapshot、通知去重和 fallback snapshot。

平台与后端索引

src/platform/runtime.ts

运行时识别：Tauri、Capacitor、Capacitor Web 和 Web fallback。

src/platform/types.ts

PlatformBridge、RuntimePlatform、WidgetBridge 等跨端抽象类型。

src-tauri/src/lib.rs

Tauri command 注册、窗口、Widget、通知、调试桥、模块窗口和业务 command。

src-tauri/src/http_client/mod.rs

HbutClient、Cookie Jar、CAS/教务域名、OCR endpoint、会话和重登公共逻辑。

src-tauri/src/db.rs

SQLite 表、缓存、用户会话、Cookie 快照、在线学习和论坛相关存储。

src-tauri/src/modules/module_bundle.rs

模块包下载、sha256、缓存目录、bundle.zip、preview_url 和路径防护。

脚本与契约索引

scripts/build_website_modules.mjs

构建 website/modules-src，写入 website/public/modules、catalog.json、manifest.json 和 bundle.zip。

scripts/build_hot_bundle.mjs

构建 dist-hot、hot-manifest.json、sha256 和热更新 zip。

scripts/check_dist_boundary.mjs

检查桌面 dist 边界，阻止 website/modules/app-resources 等目录进入桌面包。

scripts/guard_sensitive_uploads.mjs

扫描 libsql、JWT、token、敏感环境变量和误上传风险。

scripts/test_more_module_bridge.mjs

联调 catalog、manifest、/module_bundle/prepare、preview_url 和模块真实资源。

website/scripts/test-docs-ia.mjs

验证文档路由、侧栏、静态入口和参考页接入。

website/scripts/test-docs-user-content.mjs

验证用户文档内容契约和骨架占位清理。

website/scripts/test-docs-developer-content.mjs

验证开发者文档内容契约、ReferenceIndex 路径存在性检查和骨架占位清理。

产物与模块目录

website/modules-src

模块源码根目录，每个模块包含 module.json 和 source_dir。

website/public/modules

模块发布产物根目录，按 main、dev、latest 渠道保存 catalog 和模块包。

路径存在性检查

`website/scripts/test-docs-developer-content.mjs` 会读取本页，并用 existsSync 检查本页关键路径确实存在于仓库。 如果后续文件迁移、重命名或删除，契约会失败，防止引用索引变成陈旧清单。

阅读顺序

  1. 从产品视角查功能：先读快速开始、用户手册，再按教务服务、校园生活、社区与通知、扩展模块、设置与数据深入。
  2. 从架构视角查实现：先读开发者总览，再读架构与数据流、平台与 Tauri、模块系统。
  3. 从发布与风险视角查维护：先读构建发布，再读安全与隐私、故障排查。
  4. 需要定位源码时，先在本页找文件，再跳到对应专题页确认上下文和风险边界。

源码证据索引

本页索引的源码证据来自已完成 Task 1-16 的结构审计、用户功能清单、开发者专题、构建发布专题、安全隐私专题、 故障排查专题和 Checkpoint E。后续 Task 19 会再次对照源码模块清单做最终覆盖率审计。

推荐阅读路径

相关文档

当前页面读完后，可以按下面的交叉链接继续。用户文档、开发者文档、故障排查、参考资料和历史文档会互相补充。

用户手册

从用户视角理解索引中的功能页面。

开发者总览

从开发者视角理解索引中的源码路径。

Tauri API

查阅命令、桥接和 HTTP 调试入口。

开发规范

查阅工程约束、质量门禁和维护要求。