[版權(quán)聲明]:本文章由danvid發(fā)布于http://danvid.cnblogs.com/，如需轉(zhuǎn)載或部分使用請(qǐng)注明出處

　　最近在看es的文檔，發(fā)現(xiàn)查起api來真的很麻煩，很多現(xiàn)在開源的文檔都沒有查詢功能，對(duì)于忘了的一些東西，想查詢真的有點(diǎn)麻煩，找了很多方法，最后發(fā)現(xiàn)了這個(gè)工具Dash(dash只能在macOS上使用，windows用戶可以用zeal試試，好像docset是可以通用的)。

　　Dash是可以提供文檔的檢索和本地化的功能，十分適合學(xué)習(xí)之后對(duì)文檔的查找。Dash本身和很多開源項(xiàng)目合作，提供了很多的文檔下載，其中就包含的ES：

下載之后是變成一個(gè)較docset的文件，就可以使用了，在搜索框查一下就可以找到你心儀的文檔了：

如果搜不到也不用怕，我們可以自己制作，非常簡(jiǎn)單：

1.找到你要制作的文檔的首頁地址，如lucene的：http://lucene.apache.org/core/8_1_0/index.html?，使用weget命令遞歸把網(wǎng)頁全部爬下來：?

wget -r -p -np -k -P ~/tmp/ http://lucene.apache.org/core/8_1_0/index.html

2.去github上下載個(gè)html2dash的程序：https://github.com/selfboot/html2Dash?感謝一下這位兄弟[selfboot]提供的代碼，[當(dāng)然官網(wǎng)也提供了兩個(gè)程序https://github.com/technosophos/dashing和https://github.com/godbout/dash-docset-builder?]剩下的就執(zhí)行一下轉(zhuǎn)換的命令即可，這里需要注意的是執(zhí)行的文件目錄是index.html的目錄

./html2dash.py -n lucene8.1.0 -i ~/tmp/lucene_green_300.png ~/tmp/lucene.apache.org/core/7_0_0

-i 表示圖片路徑，需要是png格式，剩下的自己看github把，查詢效果：

使用起來確實(shí)很方便，大家可以試試。

?

更新：?

由于官網(wǎng)上也有程序生成docset文件https://github.com/technosophos/dashing?按github指引安裝一下dashing就可以，這個(gè)生成出來跟html2Dash相比可能更切合docset格式些，但是也要你網(wǎng)上的文檔格式比較規(guī)范。當(dāng)然這個(gè)更簡(jiǎn)單，配置一下json文件幾行命令就可以

1.首先執(zhí)行安裝命令：

brew install dashing

2.cd到你要生成的docset文件需要放在的文件夾，執(zhí)行create命令

cd ～/danvid/tmp dashing create

3.你執(zhí)行完dashing create之后會(huì)產(chǎn)生一個(gè)dashing.json文件，vim編輯一下

{"name": "elasticsearch-cn-guide","package":"elasticsearch-cn-guide","index": "index.html","selectors": {"dt a": "Command","title": "Package"},"ignore": ["ABOUT"],"icon32x32": "favicon.png","allowJS": false,"externalURL": "https://www.elastic.co/guide/cn/elasticsearch/guide/current" }

這里需要注意的是你要提前下載icon圖片到你文件夾中(favicon.png),還要必須寫"package"這個(gè)屬性，不然會(huì)生成不了(我也是開始沒命名這個(gè)，后面去issue里才知道)，然后執(zhí)行一下

dashing build tmp

就可以了，tmp就是開始你要放docset文件的文件夾

?

生成原理簡(jiǎn)單講一下(網(wǎng)上有挺多手工制作教程的，有時(shí)間也可以自己寫一個(gè)～反正我是不想寫～哈哈)：

Create the Docset Folder；建一個(gè)文件夾價(jià)格docset的后綴

Copy the HTML Documentation；復(fù)制html文件到Documentations文件夾

Create the Info.plist File；創(chuàng)建首頁文件

Create the SQLite Index；創(chuàng)建SQLite索引表

Populate the SQLite Index；插入索引數(shù)據(jù)

完事！

?

?

[參考]https://kapeli.com/docsets#dashDocset

[參考]https://segmentfault.com/a/1190000000721142

?

轉(zhuǎn)載于:https://www.cnblogs.com/danvid/p/10880313.html

總結(jié)

以上是生活随笔為你收集整理的[工具推荐]制作基于Dash的本地文档方便搜索文档api和内容的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。