Zeal(離線文檔瀏覽器)是一款能夠方便使用微軟系統(tǒng)的用戶進(jìn)行代碼的離線查詢工具,軟件能夠集成多種語言文檔,方便查閱學(xué)習(xí),zeal提供了194個(gè)文檔,常見的基本都能找到。
功能介紹
支持呼出熱鍵。只要按下組合箭 ALT+Space 即可在任何地方顯示面板,不用時(shí)可以用熱鍵隱藏的系統(tǒng)托盤。
可同時(shí)搜索多個(gè)文檔
不依賴網(wǎng)絡(luò)
GPL 協(xié)議開放源碼
Dash 中的文檔都可以在 Zeal 中使用。
使用方法
一、在首頁上面按下 Docsets 或者 Tools-->Docsets,選擇你想要的文檔進(jìn)行下載,下載完成后就可以看到你所需要的文檔了。
二、除了在 Zeal 的官網(wǎng)上面下載 Docsets 之外,還能通過 AddFeed 來添加。國(guó)外有熱心的開發(fā)者收集了一個(gè) Docsets 集合我們只需要點(diǎn)開自己需要的 Docsets,復(fù)制 xml 地址到 AddFeed 里面,就可以對(duì)應(yīng)下載 Docsets 了。
三、下載好自己需要的 Docsets 之后,日常就可以在工作中使用離線文檔進(jìn)行工作了。日常使用過程中,有幾點(diǎn)需要注意:
Zeal 原理是打開 html 的頁面,所以它相當(dāng)于一個(gè)瀏覽器,盡量養(yǎng)成定時(shí)關(guān)閉不用文檔的習(xí)慣
Zeal 能夠設(shè)置打開的快捷鍵,設(shè)置了之后就能快速打開 Zeal 查閱文檔
Zeal 左上角具備搜索功能,在前面輸入“ 文檔名稱:內(nèi)容”就可以對(duì)指定的文檔進(jìn)行搜索
四、Zeal 官方寫了一個(gè)教我們?nèi)绾稳ゾ帉懽约旱?Docsets 的文檔,但是該文檔寫得比較簡(jiǎn)單,并且沒有詳細(xì)地操作指引,操作起來比較復(fù)雜。這里借鑒CodeSheep作者的做法!
經(jīng)過實(shí)驗(yàn)之后,Zeal 的 Docsets 其實(shí)是 html 的集合,那么我們可以先用文檔工具,生成一些靜態(tài)的 html 文檔。然后通過 Docsets 官方提供的 Docsets 生成器來把 html 生成 Docsets,這樣就可以生成出屬于我們自己的 Docsets 了。
合適的文檔生成器
目前各種開發(fā)語言都有文檔生成器,我比較熟悉的 Node.js 生成器就有數(shù)十個(gè)像 Gitbook、Docsify、Vuepress 等等。但是并不是每一個(gè)都適合用來制作 Docsets,舉個(gè)例子:
Docsify 是一個(gè)很棒的生成器,但是用于 Docsets 的話就會(huì)有問題。原因是因?yàn)?Docsify 是通過 js 讀取 Markdown 來實(shí)現(xiàn)的,而 Zeal 內(nèi)部是一個(gè)瀏覽器,并沒有靜態(tài)服務(wù)器,所以制作出來的 Docsets 會(huì)出現(xiàn)跨域的問題。
最終我選擇了使用 Gitbook 來制作 Docsets,它能生成靜態(tài)的 Html 文件,并且能夠通過本地雙擊打開,能夠跟 Zeal 完美融合。