离线文档查询利器:Dash

对于一个程序员而言,阅读源码和阅读开发文档都是非常重要的技能,API 文档算是众多难啃的硬骨头当中的一块。多数文档存在着交互不友好、索引不便的问题。这个时候,你就需要一款优秀的文档阅读器。

Dash 对自身的定位是一款面向开发人员的文档查询工具。而事实上,无论是从易用性还是实用性上,Dash 都是极其强大的。简略概括如下:

  • 离线文档查阅:快速方便的 API 索引,包含 JavaScript、iOS、React、Haskell 等语言及库的文档及官方入门。
  • 第三方工具集成:与各个工具及编辑器 、IDE无缝集成,还有 jetBrain 家族、Xcode、Alfred 等等,你用的都在里面。
  • 自定义数据来源:已经包含 Google、Stack Overflow,你还可以自定义来自诸如 Medium、Quora 等任何你需要的网站。
  • 注释功能:方便快速的注释、标记功能。

可以说,Dash 绝对对得起它给自己的定位。用过之后,很可能就离不开它了。

离线文档查阅

Dash 首先是一款文档查询工具,这也是它最核心的地方。它基本上覆盖了所有主流及部分非主流语言、框架和库的文档,多数文档都来源于这些语言的官方,因此也包含了很多官方的入门介绍。

首先我们要下载对应的离线文档。

离线文档查询利器:Dash

但是这里下载有时候会非常慢,导致下载失败,我们可以通过下载离线文档,导入Dash中即可,离线文档下载地址:https://github.com/kapeli/feeds

离线文档查询利器:Dash

在里面找到我们需要下载的模块,查看内容

离线文档查询利器:Dash

这里就是下载地址,用第三方下载软件就可以下载。解压后放在任意地方,然后导入离线文档即可

离线文档查询利器:Dash

我们重点说说 API 查询。在 Dash 里查询 API 非常简单,你愿意的话可以在所有的已下载文档当中检索,或者通过双击选中某一个特定的文档之后,再输入关键字进行检索,这种情况下检索范围将会锁定在该文档内。Dash 的检索效率非常高,基本上都是秒出结果的。

离线文档查询利器:Dash

以Python文档为例,它被合理地分成了「类」「方法」「模块」「函数」「属性」「变量」等。相比于一些在线版本的文档,Dash这样的离线文档库

的优势除了能应对更多的场景外,更在于所有的内容你都能一览无余,而且方便检索,无需忍受时快时慢的国外服务器。

离线文档查询利器:Dash

第三方工具集成

作为一款开发文档浏览器,Dash 针对许多的工具与 IDE 都做了无缝集成。基本上你有用到的、你会用到的工具都在官方支持之列了。插件的安装方法在其 GitHub 对应的各个Repository上都有详细的安装指导,点击这上面对应的工具图标就可以找到了。

离线文档查询利器:Dash

以 Alfred 为例,直接点击图标之后会自动跳转到 Alfred,点击导入就安装好了。集成 Dash 之后搜索起来非常方便,简直不要太方便。

离线文档查询利器:Dash

感受一下随手查阅的畅快感。

离线文档查询利器:Dash

自定义数据来源

Dash内置的文档已经很丰富了,但是往往我们需要搜索的东西更多,很多时候我们需要搜索来自Web的内容。默认情况下,Dash支持在线搜索的内容,是Google,DuckDuckGo,Stack Overflow。但是这三个软件在国内要么不能访问,要么访问速度太慢,所以不能满足我们的需要。我们可以通过下面的方式添加知乎的搜索:

离线文档查询利器:Dash

添加注释

Dash 还附带了一个注释工具,你可以对文档的任意一个小节添加注释,添加注释前需要创建账号

离线文档查询利器:Dash

创建以后,在浏览文档的任意地方,都可以点击右上方的+号,就可以添加注释了

离线文档查询利器:Dash

而且还有书签功能,你可以添加书签来标记常用的API或者看了一半的功能,以备之后查阅。

离线文档查询利器:Dash

总的来说,Dash是一款非常优秀的文档阅读器,不仅文档类型全面,最重要是使用方便。阅读源码和阅读开发文档是程序员必备的技能,所以有一款方便的工具就必不可少了。

Dash是Mac平台上的工具,我在公司使用的Windows机器,有一款同样优秀的文档阅读器:Zeal,适用于Windows、Linux、Mac多个平台,它所使用的文档与Dash是通用的,所以下载离线文档的方式也是适用的。


分享到:


相關文章: