src | ||
.gitignore | ||
COPYING | ||
README.md | ||
shippable.yml | ||
zeal.pro |
Zeal
zeal noun
- a feeling of strong eagerness (usually in favor of a person or cause)
- excessive fervor to do something or accomplish some end
- prompt willingness
(from WordNet 3.0)
Zeal is a simple offline documentation browser inspired by Dash.
Download
For details about binary packages (currently available for Windows and Ubuntu) see downloads page. Also, the latest unstable builds are available here.
How to use
After installing Zeal, you need to download docsets. Go to File->Options->Docsets, select the ones you want, and click the Download button.
How to compile
If you prefer to compile Zeal manually.
Requirements
- Qt 5.2+
- X C Binding – keysyms (Ubuntu
libxcb-keysyms1-dev
) bsdtar
is required for the built-in docset extracting to worklibappindicator
andlibappindicator-devel
for notifications- you may need to install
libqt5webkit5-dev
andqtbase5-private-dev
To compile it, run qmake
and make
in the zeal
directory. On Linux, a final make install
is required to install icons.
Query & Filter docsets
You can limit the search scope by using ':' to indicate the desired docsets.
java:BaseDAO
You can also search multiple docsets separating them with a comma:
python,django:string
Command line
If you prefer, you can start with Zeal queries from command line, for this, use the option --query
:
zeal --query python:bomb
TODO
- Issues
- Search enhancements - some ideas:
- Allow selecting subset of docsets to search in (enable/disable docsets, docset groups)
- Grouping of similar results (like overloaded functions)
- Code cleanup
- Refactoring to reuse common code between
ZealDocsetsRegistry
andZealListModel
- Refactoring to reuse common code between
Creating your own docsets
You can use Dash's instructions for generating docsets.