Skip to content

geniousli/zeal

 
 

Repository files navigation

Zeal

Changelog Gitter IRC Telegram Channel Twitter

Build Check 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

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:

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.

About

Offline documentation browser inspired by Dash

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 96.2%
  • CMake 2.6%
  • Other 1.2%