Repository: zealdocs/zeal

Stars: 12599

README.md Copy Chapter

Zeal



Zeal is a simple offline documentation browser inspired by Dash.

!Screenshot

Download Copy Chapter

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

How to use Copy Chapter

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

How to compile Copy Chapter

Build dependencies Copy Section

* CMake.
* Qt version 6.4.2 or above. Required module: Qt WebEngine Widgets.
* libarchive.
* SQLite.
* X11 platforms only: xcb-util-keysyms.

Build instructions Copy Section

cmake -B build
cmake --build build

More detailed instructions are available in the wiki.

Query & Filter docsets Copy Chapter

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 Copy Chapter

If you prefer, you can start Zeal with a query from the command line:

zeal python:pprint

Create your own docsets Copy Chapter

Follow instructions in the Dash docset generation guide.

Contact and Support Copy Chapter

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 in #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 <[email protected]>.

License Copy Chapter

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