工具推荐之zeal

推荐下文档工具zeal

工具推荐之zeal

大家如果有mac可能会用到dash这个工具,但是dash本身并不能在win或者linux平 台使用,所以如果有速查文档的需求,可以了解下zeal。

什么是zeal

给软件开发者的离线文档查询软件,可以理解为类似离线html,可以支持搜索等。 更多请参考官网https://zealdocs.org/

zeal如何使用

docsets文档相关

在线下载docsets

菜单栏依次选择tools->Available ../images/zeal/online-docsets.png◎ ../images/zeal/online-docsets.png

点击进行下载即可,有时候可能由于各种原因无法下载,这个时候就需要离线下 载。

离线下载docsets

菜单栏依次选择Edit->Preference或者使用快捷键Ctrl+,找到Docset storage选 项。 ../images/zeal/zeal-dockset-postion.png◎ ../images/zeal/zeal-dockset-postion.png

一般个人不建议离线,你可以使用别人已经下载好的,把目录共享给你即可。

点击browse,把你下载的docsets解压即可,那么问题来了,docsets资源在哪

离线docsets

https://lucasg.github.io/2017/02/05/Downloading-Dash-docsets/ 这里主要 有一些地址

1
{"name" : "Vim", "url" : "http://sanfrancisco.kapeli.com/feeds/Vim.tgz"},

比如你要下载vim,直接下载这个解压也可以,当然google下download dash docsets 也可以。

解压docsets到上面指定位置即可
自己生成docsets

和常用IDE集成

可以根据官网的使用说明链接找到对应的插件页面,

这里来自官网

IDE Plugins
Atom

An Atom package is available at https://atom.io/packages/dash.

Brackets

There is a Brackets integration available at https://github.com/anephew/brackets-zeal.

Emacs

There is an Emacs package available at https://github.com/jinzhu/zeal-at-point.

IntelliJ IDEA

There is an IDEA plugin available at https://plugins.jetbrains.com/plugin/7351?pr=idea.

KTextEditor (Kate, KWrite, KDevelop, Kile, etc)

A plugin for KTextEditor-based editors is available at https://github.com/g3ar/ZealSearch.

Sublime Text

There is a Sublime Text 2/3 package available at https://github.com/vaanwd/Zeal.

VIM

There is a Vim plugin available at https://github.com/KabbAmine/zeavim.vim. Or you can use https://github.com/keith/investigate.vim with something like this in .vimrc:

1
2
3
let g:investigate_command_for_python = '/usr/bin/zeal ^s'
A simpler way to integrate with Vim is a simple mapping, like
:nnoremap gz :!zeal "<cword>"&<CR><CR>
Visual Studio Code

There is a VSCode plugin available at https://github.com/deerawan/vscode-dash.

场景介绍

比如MySQL的grant语法突然忘记了,我想查询下

打开zeal,搜索输入grant,弹出grant的相关信息和示例,在里面也会自动链接 到其他比如SELECT等,非常方便。 ../images/zeal/grant-example.png◎ ../images/zeal/grant-example.png

../images/zeal/grant-example.gif◎ ../images/zeal/grant-example.gif

编辑器集成

这里简单演示下emacs下面操作,其他类似 ../images/zeal/emacs-inte.gif◎ ../images/zeal/emacs-inte.gif