Zread Docs for GitHub

在 GitHub 仓库页直接查看 zread.ai 文档：侧栏目录、页内阅读、图表渲染与章节导航。

Zread Docs for GitHub 把仓库的 Zread.ai AI 文档直接带到你正在浏览的 GitHub 仓库页里，无需切换标签、无需打开另一个网站。 功能 • 目录侧栏：在任意仓库主页的 README 旁显示该仓库 Zread 文档的树状目录（section / group / 页面可折叠）。 • 页内阅读：点击任意条目，文档直接在 README 区域内渲染，复用 GitHub 自带的排版、代码高亮与复制按钮。 • 图表渲染：文档中的 Mermaid 图表内联渲染，支持全屏查看（缩放/拖动/重置）；语法错误的图表回退显示源码，而不是报错框。 • 章节导航：右侧细进度轨跟随当前阅读章节；悬停展开目录卡片，点击跳转到任意标题。 • 缓存与预取：文档本地缓存（约 50MB 上限、LRU 淘汰）并后台串行预取，二次打开秒开。 • 自动收录/刷新：未被 Zread 收录的仓库可一键提交收录（显示排队预估）；过期文档自动刷新；刷新期间继续展示旧文档。 • 语言：界面与文档内容跟随浏览器语言——中文浏览器显示中文，否则英文。 • 暗色模式：跟随系统偏好。 • 无打扰：扩展不会自行打开任何可见标签页，后台工作不产生新标签或窗口。 使用方法 1. 安装扩展后打开任意 GitHub 仓库主页（例如 https://github.com/owner/repo）。 2. 文档侧栏会在 README 旁自动加载。 3. 点击目录中的页面即可页内阅读；点击原生 README 标签恢复原 README；用 README 头部的「Zread 文档」按钮开关侧栏。 4. 仓库尚未收录时，使用侧栏中的一键提交；收录排队期间会显示预估等待时间。 隐私 扩展只与 github.com（用于显示界面）和 zread.ai（用于获取文档）通信。仅在你登录 zread.ai 时读取该站登录 cookie 用于文档请求鉴权，文档缓存保存在你的设备上。无统计、无追踪、无广告。完整隐私政策：https://github.com/ejfkdev/zread-ext/blob/main/PRIVACY.md 权限说明 • zread.ai 的 Cookie——仅在你登录时用于文档请求鉴权。 • github.com 的 scripting 与宿主权限——显示侧栏并在 README 区域渲染文档。 • zread.ai 的宿主权限——获取文档、收录状态与刷新。 • storage——本地文档缓存以实现秒开。 • tabs 与 alarms——管理隐藏的后台抓取上下文与预取调度。 支持 问题与反馈：https://github.com/ejfkdev/zread-ext/issues