一句话简介
将技术文档离线到本地,随时查阅,及时更新。
假设一个场景
你坐在一间咖啡馆里,迫于无良老板而无法专注享受咖啡,无奈地掏出笔记本,追赶自己的代码进度。然而因为天气炎热,老板家的路由器处在罢工与罢工之间……写代码可以没网,进度可以换个地方上传。但是,没文档谁会写代码?!反正我不会。
其实我经历的真实场景是,作为一个自由职业者,正在为自己的想法兴奋,想要用代码去实现的时候,家里停电了。没所谓的,我笔记本续航起码 8h,但没网,你说手机?!反正有那么一段时间附近的基站(中继信号塔)明显没有 UPS,我这儿一停电,信号就成 2G。没文档查阅真不会写代码。
有点强迫症
我也是用过一些工具,比如 Utools 里面有插件可以下载一些文档。其实也足够用了,但我总期望文档能保持最新,别回头发现我在读两年前的东西。
一个发现
然后我好奇搜索 MDN 离线,找到了这样一个页面: Offline MDN Docs - Kapeli,这很赞!而且显然是经常更新的,迫不及待的收藏起来,并希望发现更多。然后读到了,重点的一句:
please consider using a documentation browsing app like Dash (macOS), Velocity (Windows) or Zeal (Linux) instead. These apps will help you get the most out of the docs, by providing a search index and quick access to everything you need.
请考虑使用文档浏览应用程序,如Dash(macOS),Velocity(Windows)或Zeal(Linux)。这些应用程序将通过提供搜索索引和快速访问所需的一切来帮助您充分利用文档。
先说价格
- Dash ¥120,仅支持 MacOS
- Velocity $19.95 仅支持 Windows
- Zeal 免费,支持 MacOS、Windows、Linux
一个重点
文档当然就在网上,但是能够下载,并维护更新的是 Dash,这三者都使用的 Dash 的源( docsets)其中包含了大部分常用技术和框架的文档,约 200+。而且都如上方页面一般,提供了直接下载(但我不知道怎么找出所有上述页面)
区别
Dash 说支持第三方文档源,但设置起来不知道是否麻烦(我没条件测试),Zeal 也支持第三方,但是你要自己制作一个 Dash docsets 规格的订阅链接
最后
虽然用到的概率其实不大,但多数文档因为几乎是纯文字,所以体积也不算大,下载一份,万一用到就会觉得很爽。
文档源
似乎这里( GitHub - Kapeli/feeds: Collection of Dash docset feeds )是文档源,可以点开文件看到下载地址。翻翻主页还有用户提供的大量文档源( GitHub - Kapeli/Dash-User-Contributions: Dash repo of user contributed docsets )。