Zread Docs for GitHub — 在 GitHub 仓库页方便查看 zread.ai 文档

在 GitHub 想搞清一个陌生仓库怎么搭的,能看的入口这些年没怎么变:一份 README、一棵目录树,再看就得自己翻文件。麻烦的是两处不在一个页面上:文档要另开一个标签才看得到,来回对照时刚才那点上下文就断了;仓库页上那份 README 又常常只有几句介绍。这个 Zread Docs for GitHub 浏览器拓展 把目录挂在仓库页左边,点一条就在原本放 README 的地方展开,不想看了点回去就是原始内容。

Zread Docs for GitHub是一个装在 Chrome 上的插件,已在应用商店上架。装好之后打开任意 GitHub 仓库页,左侧会多出一列文档目录,点哪一条,正文就显示在原本 README 那块区域里。文档本身来自一个把仓库读一遍、生成带目录说明的服务,属于替人先读一遍的 AI工具。

它只做展示这一件事:目录可以折叠,章节按层级排开,读完想看原始内容,点 GitHub 自带的 README 标签就切回去,页面不跳走、也不另开窗口。

功能特点

  • 📚 目录侧栏:仓库页左侧显示 zread 文档目录(可折叠 section/group),点击在 README 区域阅读;窄屏被遮挡时,鼠标移入侧栏或其两侧空白会带过渡动画漂移到可视区域,并始终浮在页面内容之上。
  • 🔁 README 切换:点击 GitHub 原生 README 标签恢复原始内容。
  • ⚡ 缓存 + 预取:目录/文档本地缓存(≤50MB、LRU),后台串行预取,二次打开秒开。
  • 🤖 自动收录/刷新:未收录自动提交并显示排队 ETA;收录超 7 天自动刷新;刷新中仍展示旧文档。
  • 🧩 代码复制:为渲染的代码块添加仿 GitHub 的复制按钮。
  • 📊 Mermaid 图表:渲染流程图,支持全屏预览(缩放/拖动/重置),按需分包加载;语法错误的图表回退显示源码。
  • 🧭 页内导航:文档右侧进度轨 + 悬停目录卡片,跟随滚动、点击跳转章节。
  • 🕶️ 无打扰:全程不自动创建任何窗口/标签页;zread.ai 触发人机验证时在左侧文档面板给出提示,由你手动打开一次 zread.ai 完成验证。
  • 🔒 隐私:只与 github.com / zread.ai 通信,无统计无追踪,见 隐私政策。
  • 🌙 暗色模式:跟随系统 prefers-color-scheme。
  • 🌐 国际化:浏览器为中文时显示中文,否则英文(界面与内容均跟随)。

作为 开源 的一类小工具,它把力气花在「读得顺」而不是「功能多」上。

目录挂在仓库页左侧

  • 文档目录和仓库原有界面并排放着,章节与分组可以折叠,点一条就在 README 区域展开。
  • 窗口窄、侧栏被挡住时,鼠标移到侧栏或它两边的空白处,侧栏会滑到看得见的位置,并且浮在页面内容之上。
  • 右侧还有一条进度轨,跟着滚动走,也能点着跳章节;鼠标悬停会浮出目录卡片。

缓存与自动收录

  • 目录和正文存在本机,上限五十兆,后台按顺序提前取好,第二次打开几乎是秒开。
  • 仓库还没被收录时会自动提交,面板上显示排队的预计时间;收录超过七天会自动刷新,刷新期间照旧显示旧文档。
  • 遇到对方要求人机验证,插件不自己弹窗口,只在左侧面板提示,由使用者手动打开一次完成验证。

图表、代码与页面细节

  • 文档里的流程图会渲染出来,能全屏看、缩放、拖动、复位;图表写得有语法错误时,退回显示原始文本。
  • 渲染出来的代码块带一个和 GitHub 样式一致的复制按钮。
  • 深色模式跟随系统设置;浏览器语言是中文就显示中文界面与中文内容,否则显示英文。

不打扰与数据

  • 全程不自动创建窗口或标签页。
  • 只与仓库站点和文档服务通信,没有统计与追踪。

使用教程

  1. 在应用商店搜索Zread Docs for GitHub安装,或者下载文末加载包后加载。
  2. 打开任意一个仓库页,地址里带上仓库名就行,结尾有没有斜杠都可以。
  3. 左侧出现文档目录后,点开想看的章节,正文会显示在原本 README 的位置。
  4. 想回到原始内容,点页面上 GitHub 自带的 README 标签。
  5. 首次打开尚未收录的仓库,面板会显示排队进度,等收录完成后刷新一次页面即可。
  6. 看流程图时可以点全屏,缩放和拖动都在全屏里操作,看完点复位。

愿意自己改的话,仓库里 开发者工具 那套流程也齐:装好依赖后一条命令起开发环境,构建产物在 dist/chromium,再按同样方式加载。

使用感受

最舒服的一点是它不抢地方。文档就长在仓库页上,左边目录、右边正文,跟读一个普通仓库页没什么两样;想对照原始说明,点一下 README 标签就回去,不用在两个标签之间来回搬上下文。这类 工具推荐 里,肯把「退回去」这条路留顺的不多。

缓存和自动刷新也省心。第二次打开同一个仓库几乎是秒开,收录过七天的文档会自己更新。更新期间还照旧显示旧的那份,不会让人对着一片空白猜是没生成还是没加载完。作为 开源项目,代码和隐私政策都能自己翻,这点比闭源插件让人放心。

文档由那个外部服务生成,内容准不准不由插件保证;仓库没被收录时要等排队,遇到人机验证得自己手动过一次。按 实用软件 的标准看,它胜在位置选得对——把 效率工具 该省的那几步省掉,又不改动仓库页本身的用法。

官方网站

https://github.com/ejfkdev/zread-ext

访问

下载地址

https://pan.quark.cn/s/4f55f05d26cd

https://www.guangyapan.com/s/1952211499115839579_aeWhI5wocgzRgCO6(光鸭新用户注册福利:永久免费空间:所有新用户注册即可解锁 2TB 永久免费存储空间,无需额外任务或付费)

相关推荐

Avatar photo

JameCling

我是 格律诗的软件世界 的作者,一名专注于软件工具、AI 技术和数字效率领域的独立研究者。
多年来,我持续关注互联网工具的发展趋势,体验不同平台的软件产品,并研究它们如何帮助用户提升效率。
我的工作不仅是整理软件信息,而是通过实际测试、功能分析和使用场景研究,帮助用户判断一个工具是否真正值得使用。
格律诗的软件世界 的每一篇文章都希望提供真实、有价值的信息,包括工具特点、使用方法、优缺点分析以及适合的人群。
我相信,好的工具能够改变工作方式,而准确的信息能够帮助用户做出更好的选择。