LimitlessDonald/zeal

Offline documentation browser inspired by Dash

Zeal

Zeal is a simple offline documentation browser inspired by Dash.

Download

Get binary builds for Windows and Linux from the download page.

How to use

After installing Zeal go to Tools->Docsets, select the ones you want, and click the Download button.

How to compile

Build dependencies

• CMake.
• Qt version 5.9.5 or above. Required module: Qt WebEngine Widgets.
• libarchive.
• SQLite.
• X11 platforms only: Qt X11 Extras and xcb-util-keysyms.

Build instructions

cmake -B build
cmake --build build

More detailed instructions are available in the wiki.

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 Zeal with a query from the command line:

zeal python:pprint

Create your own docsets

Follow instructions in the Dash docset generation guide.

Contact and Support

We want your feedback! Here's a list of different ways to contact developers and request help:

• Report bugs and submit feature requests to GitHub issues.
• Reach developers and other Zeal users on Gitter or #zealdocs IRC channel on Libera Chat (web client).
• Ask any questions in our GitHub Discussions.
• Do not forget to follow @zealdocs on Twitter!
• Finally, for private communication shoot an email to zeal@zealdocs.org.

License

This software is licensed under the terms of the GNU General Public License version 3 (GPLv3). Full text of the license is available in the COPYING file and online.