文档是一棵 Markdown 树,里面有代码示例、图表、公式,偶尔还有 PDF —— 这和 FoldRender 本来就能读的形状非常接近。本页讲怎么把一个文档仓库变成在展开的手机上能好好读的东西(包括离线),以及让一棵很大的文档树在小设备上也好用的导航习惯。
FoldRender 在 Play 商店上的名字是 FoldRender: Git Repo Reader,包名 dev.foldrender.app,免费,面向全球发行。照常安装即可 —— 不会弹出要你打开「允许来自此来源的应用」的提示,更新也会自动送达。应用声明了 minSdk 30,所以需要 Android 11 或更新的版本;如果设备低于这个版本,Play 会直接告诉你,而不是让你装上一个跑不起来的版本。
大多数项目把文档放在仓库里,通常在 docs/ 下。点分支图标打开 Git 面板,把 HTTPS 地址粘贴到 筛选,或输入 owner/repo,点 获取代码。公开仓库可以匿名克隆。如果文档有自己单独的仓库,就克隆那个 —— 它会比代码仓库小得多,列出来也快得多。
大仓库第一次列出文件树要很久,只显示一个转圈,没有进度提示;大约 4,600 个文件时,是真要等一会儿。只放文档的仓库通常小到碰不上这个问题,这也是有得选时克隆文档仓库、而不是整个 monorepo 的一个好理由。
在文件标签页里展开 docs/。目录在你展开时才按需列出子项,加载时那一行有自己的小转圈。被仓库 .gitignore 隐藏的文件 —— 比如构建出来的站点目录 —— 不会碍事,需要时可以用显示被忽略的文件开关显示出来。
点一个 Markdown 文件,它会在右边那一栏渲染。右下角的小悬浮按钮会打开大纲面板:这一页的顶层标题,你当前所在的那个会突出显示,点一下就滚动到那里。在一份很长的 API 参考上,这就是「阅读」和「翻找」的区别。
字号图标会打开阅读面板。行宽从 480 dp 到 1200 dp,字号从 80% 到 160%,主题有跟随系统 / 浅色 / 深色,还有一个衬线字体开关。把行收窄,展开的屏幕读长篇文档页面时才是真的读着舒服,而不只是屏幕大。
顶栏里的放大镜在当前打开的页面内查找,带实时匹配计数。左栏的搜索标签页在整棵文档树里 grep —— 按字面或正则 —— 结果以 path:line 行的形式陆续出现,附带预览,点一下就在那一行打开。对文档来说,这通常是两者中更有用的那个:问题一般是「哪一页提到了这个」。
围栏代码块带高亮、语言标签和一个复制代码按钮。```mermaid 代码块和 $…$ / $$…$$ 公式在正文里直接渲染;点一下图表会全屏打开并可以双指缩放。用 > [!WARNING] 写的 callout、脚注、wiki 链接和 YAML front matter 都按它们本来的样子渲染,而不是显示成引用的源码。
克隆下来之后,上面的一切都不需要联网 —— 包括图表和公式,它们由 APK 自带的 mermaid 和 KaTeX 渲染,负责渲染的 WebView 的网络访问被封锁。只有 Pull(跟上上游文档的更新)需要联网。
docs 文件夹以文件树的形式浏览,页面在右边,这正是文档真实的形状 —— 而不是一个搜索框加上碰运气。每个文档的滚动位置都会保存,所以在三个页面之间来回切换,哪个都不会丢掉读到的位置。
提交进仓库的规范、RFC 和厂商数据手册,在同一个栏里打开,带页码计数和点一下就能跳转的缩略图条。CSV 数据文件、JSON 和 YAML 配置,以及包括 SVG 在内的图片也一样。
Markdown 有「导出」面板:「打印 / 存为 PDF」走 Android 打印框架;「分享为 HTML」是一个自包含的文件,字体、公式、图表和图片都以 data URI 内嵌;「分享为 PNG」是一整张长图。
如实列出的清单 —— 包括已随版本发布但没有验证过的行为 —— 让你在安装前就能判断,这个版本能不能做你要做的那件事。
大家真正会用的四个应用,以及把它们区分开的那一条:仓库最后在不在手机上,到了手机上有没有东西把它渲染出来。
| 工具 | 下载价格 | 从哪里获取 | 克隆到设备上 | 渲染 PDF / Jupyter 笔记本 / Markdown | 编辑器或 shell |
|---|---|---|---|---|---|
| FoldRender | US$0 | Google Play,全球 | 能 —— HTTPS,公开仓库可匿名 | 能 —— 原生 Compose 渲染器 | 没有,有意为之:它是阅读器,不是 IDE |
| GitHub Mobile | US$0 | Google Play 和 App Store | 不能 —— 它读的是托管在 GitHub 上的仓库 | 只有 GitHub 自己渲染的内容,需联网 | 可在 PR 里编辑文件 |
| Termux + git | US$0 | F-Droid 或 GitHub | 能 —— 真正的 git 命令行 | 不能 —— 只有终端文本 | 有,完整的 shell,任何命令行编辑器都能用 |
| MGit 1.7.0 (2023) | US$0 | 只在 F-Droid | 能 —— 克隆、拉取、推送,HTTPS 或 SSH 密钥 | 不能 | 没有 —— 它自己的页面写明不带文本编辑器 |
价格指的是下载价格。GitHub Mobile 的功能取决于你的 GitHub 套餐;Termux 和 MGit 都是自由软件。MGit 的版本和日期来自它在 F-Droid 上的页面。
这里的每个数字都是从正式发布的版本里读出来的,或者来自本页底部列出的一手资料 —— 没有为了好看往上凑整。
minSdk 30,也就是 2020 年随 Android 11 发布的 API 级别;编译和目标版本都是 API 36。上面这些数字背后的一手文档,任何一条你都可以自己核对,不必听我们说。
git-clone 参考文档 —— 获取代码执行的操作,由定义它的项目自己来说明minSdk 定为最低要求的那个版本本页最后核对于 2026-08-27。