[版权声明]:本文章由danvid发布于http://danvid.cnblogs.com/,如需转载或部分使用请注明出处

  最近在看es的文档,发现查起api来真的很麻烦,很多现在开源的文档都没有查询功能,对于忘了的一些东西,想查询真的有点麻烦,找了很多方法,最后发现了这个工具Dash(dash只能在macOS上使用,windows用户可以用zeal试试,好像docset是可以通用的)。

  Dash是可以提供文档的检索和本地化的功能,十分适合学习之后对文档的查找。Dash本身和很多开源项目合作,提供了很多的文档下载,其中就包含的ES:

下载之后是变成一个较docset的文件,就可以使用了,在搜索框查一下就可以找到你心仪的文档了:

如果搜不到也不用怕,我们可以自己制作,非常简单:

1.找到你要制作的文档的首页地址,如lucene的:http://lucene.apache.org/core/8_1_0/index.html ,使用weget命令递归把网页全部爬下来:

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

2.去github上下载个html2dash的程序:https://github.com/selfboot/html2Dash 感谢一下这位兄弟[selfboot]提供的代码,[当然官网也提供了两个程序https://github.com/technosophos/dashinghttps://github.com/godbout/dash-docset-builder ]剩下的就执行一下转换的命令即可,这里需要注意的是执行的文件目录是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把,查询效果:

使用起来确实很方便,大家可以试试。

更新:

由于官网上也有程序生成docset文件https://github.com/technosophos/dashing 按github指引安装一下dashing就可以,这个生成出来跟html2Dash相比可能更切合docset格式些,但是也要你网上的文档格式比较规范。当然这个更简单,配置一下json文件几行命令就可以

1.首先执行安装命令:

brew install dashing

2.cd到你要生成的docset文件需要放在的文件夹,执行create命令

cd ~/danvid/tmp
dashing create

3.你执行完dashing create之后会产生一个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"这个属性,不然会生成不了(我也是开始没命名这个,后面去issue里才知道),然后执行一下

dashing build tmp

就可以了,tmp就是开始你要放docset文件的文件夹

生成原理简单讲一下(网上有挺多手工制作教程的,有时间也可以自己写一个~反正我是不想写~哈哈):

  1. Create the Docset Folder;建一个文件夹价格docset的后缀

  2. Copy the HTML Documentation;复制html文件到Documentations文件夹

  3. Create the Info.plist File;创建首页文件

  4. Create the SQLite Index;创建SQLite索引表

  5. Populate the SQLite Index;插入索引数据

完事!

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

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

[工具推荐]制作基于Dash的本地文档方便搜索文档api和内容的更多相关文章

  1. 使用requests爬取梨视频、bilibili视频、汽车之家,bs4遍历文档树、搜索文档树,css选择器

    今日内容概要 使用requests爬取梨视频 requests+bs4爬取汽车之家 bs4遍历文档树 bs4搜索文档树 css选择器 内容详细 1.使用requests爬取梨视频 # 模拟发送http ...

  2. 低成本制作基于OpenWRT的渗透工具

    不知道你听说过Hak5的产品没有,它们可是黑客以及渗透测试人员的最爱.其中,有很多的PoC黑客工具都曾在热门美剧<黑客军团>中出现过.Hak5的 PACKETSQUIRREL 上架已经有好 ...

  3. Mac iOS Mac Watch 应用和游戏编程开发工具推荐

    今日分享「iOS / Mac / Watch 应用和游戏开发工具」推荐,这期专题主要为iOS开发者推荐一些优秀的设计和开发工具,这些工具包含移动原型的设计.程序的开发等,可以大大提高开发的效率!专题会 ...

  4. 10款Mac上程序员装机必备的开发工具推荐和下载

    10款Mac上程序员装机必备的开发工具推荐和下载 使用Mac的用户主要有两大类:设计师和程序员,为各位程序员童鞋推荐10个Mac上非常棒的开发工具和辅助工具,分享软件专题[10款Mac上程序员装机必备 ...

  5. 值得推荐的C/C++框架和库(深度好文)

    [本文系外部转贴,原文地址:http://www.cppblog.com/merlinfang/archive/2014/12/26/209311.html http://coolshell.info ...

  6. 工具推荐--刷LeetCode的神器

    本文首发于微信公众号:[坂本先生],文章地址为: https://mp.weixin.qq.com/s/vHv5hO8nils_g2VSKwu1Cg如有转载请标明出处 今天给大家安利一款快速刷Leet ...

  7. [转帖]推荐一款比 Find 快 10 倍的搜索工具 FD

    推荐一款比 Find 快 10 倍的搜索工具 FD https://www.hi-linux.com/posts/15017.html 试了下 很好用呢. Posted by Mike on 2018 ...

  8. 基于ConcurrentHashMap的本地缓存

    基于ConcurrentHashMap的本地缓存 在系统中,有些数据,数据量小,但是访问十分频繁(例如国家标准行政区域数据),针对这种场景,需要将数据搞到应用的本地缓存中,以提升系统的访问效率,减少无 ...

  9. 工具推荐-使用RedisInsight工具对Redis集群CURD操作及数据可视化和性能监控

    关注「WeiyiGeek」公众号 设为「特别关注」每天带你玩转网络安全运维.应用开发.物联网IOT学习! 希望各位看友[关注.点赞.评论.收藏.投币],助力每一个梦想. 本章目录 目录 0x00 快速 ...

随机推荐

  1. Hadoop 指令

    date: 2018-04-30 09:07:56 updated: 2018-04-30 09:07:56 1.ls hadoop fs -ls / 列出hdfs文件系统根目录下的目录和文件 had ...

  2. C# 编译器对局部变量的优化

    C# 编译器对局部变量的优化 C# 的编译器可以对代码进行优化,所以,我们在写代码的时候,可以更多地考虑一下代码的易读性问题. 不考虑基本的对齐和换行美化.看一下局部变量优化问题. C# 示例代码 例 ...

  3. Java 复制到剪贴板

    public void copy(String str) { StringSelection stsel = new StringSelection(str); Toolkit.getDefaultT ...

  4. Codeforces Round #679 (Div. 2, based on Technocup 2021 Elimination Round 1)

    考场上只做出来四道,第二天一早就写出来了E,蛮绝望的. A Finding Sasuke 水构造 #include <cstdio> #include <algorithm> ...

  5. 群晖DS218+部署mysql

    欢迎访问我的GitHub https://github.com/zq2599/blog_demos 内容:所有原创文章分类汇总及配套源码,涉及Java.Docker.Kubernetes.DevOPS ...

  6. C语言程序设计之 数组2020-10-28

    C语言程序设计之 数组2020-10-28 整理: 第一题:求最小数与第一个数交换 [问题描述] ​ 输入一个正整数n (1<n<=100),再输入n个整数,将最小值与第一个数交换,然后输 ...

  7. 使用 IDEA 查看 JDK8 源码

    使用 idea 查看 oracle jdk 8 源码时发现 Unsafe 没有源码. 解决方法: 到 openjdk-8 下载页面:http://jdk.java.net/java-se-ri/8-M ...

  8. MIT 6.S081 Lab5 Copy-On-Write Fork

    前言 最近绝大多数的空闲时间都拿来锤15-445了,很久没动6.S081.前几天回头看了一下一个月前锤完的Lazy Allocation,自己写的代码几乎都不认识了.......看来总结之类的东西最好 ...

  9. .netcore简单集成swagger

    为什么要集成Swagger 在前后端分离比较普遍的当下,当后端开发完接口后,还需把接口的信息.参数说明.返回参数等信息编写好提供给调用者.对于对外开放接口需提供说明文档是必不可少的.但是对于内部开发, ...

  10. Android Google官方文档(cn)解析之——Intents and Intent filter

    应用程序核心组件中的三个Activity,service,还有broadcast receiver都是通过一个叫做intent的消息激活的.Intent消息传送是在相同或不同的应用程序中的组件之间后运 ...