Zeal是一款能够方便使用微软系统进行代码查询的离线开发文档浏览工具,软件能够集成多种语言文档,方便查阅学习,zeal提供了194个文档,常见的基本都能找到。Zeal是Docsets开发帮助文件的浏览器和管理软件,通过该软件可下载最新的C、C++标准帮助文件。
功能介绍
支持呼出热键。只要按下组合箭 ALT+Space 即可在任何地方显示面板,不用时可以用热键隐藏的系统托盘。
可同时搜索多个文档。
不依赖网络。
GPL 协议开放源码。
Dash 中的文档都可以在 Zeal 中使用。
使用方法
一、在首页上面按下 Docsets 或者 Tools-->Docsets,选择你想要的文档进行下载,下载完成后就可以看到你所需要的文档了。
二、除了在 Zeal 的官网上面下载 Docsets 之外,还能通过 AddFeed 来添加。国外有热心的开发者收集了一个 Docsets 集合我们只需要点开自己需要的 Docsets,复制 xml 地址到 AddFeed 里面,就可以对应下载 Docsets 了。
三、下载好自己需要的 Docsets 之后,日常就可以在工作中使用离线文档进行工作了。日常使用过程中,有几点需要注意:
Zeal 原理是打开 html 的页面,所以它相当于一个浏览器,尽量养成定时关闭不用文档的习惯。
Zeal 能够设置打开的快捷键,设置了之后就能快速打开 Zeal 查阅文档。
Zeal 左上角具备搜索功能,在前面输入“ 文档名称:内容”就可以对指定的文档进行搜索。
四、Zeal 官方写了一个教我们如何去编写自己的 Docsets 的文档,但是该文档写得比较简单,并且没有详细地操作指引,操作起来比较复杂。这里借鉴CodeSheep作者的做法。
经过实验之后,Zeal 的 Docsets 其实是 html 的集合,那么我们可以先用文档工具,生成一些静态的 html 文档。然后通过 Docsets 官方提供的 Docsets 生成器来把 html 生成 Docsets,这样就可以生成出属于我们自己的 Docsets 了。
五、合适的文档生成器
目前各种开发语言都有文档生成器,我比较熟悉的 Node.js 生成器就有数十个像 Gitbook、Docsify、Vuepress 等等。但是并不是每一个都适合用来制作 Docsets,举个例子:
Docsify 是一个很棒的生成器,但是用于 Docsets 的话就会有问题。原因是因为 Docsify 是通过 js 读取 Markdown 来实现的,而 Zeal 内部是一个浏览器,并没有静态服务器,所以制作出来的 Docsets 会出现跨域的问题。
最终我选择了使用 Gitbook 来制作 Docsets,它能生成静态的 Html 文件,并且能够通过本地双击打开,能够跟 Zeal 完美融合。