Skip to content
Offline documentation browser inspired by Dash
C++ CMake HTML Other
Branch: master
Clone or download

README.md

Zeal

Changelog Gitter IRC Telegram Channel Twitter

AppVeyor Coverity Scan

Zeal is a simple offline documentation browser inspired by Dash.

Screenshot

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

Required 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.

Building instructions

mkdir build && cd build
cmake ..
make

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

Creating your own docsets

Follow 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:

If you feel generous and want to show some extra appreciation:

Buy me a coffee

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.

You can’t perform that action at this time.