離線文檔查詢利器: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是通用的,所以下載離線文檔的方式也是適用的。


分享到:


相關文章: