Github url

zeal

by zealdocs

zealdocs /zeal

Offline documentation browser inspired by Dash

8.0K Stars 603 Forks Last release: almost 2 years ago (v0.6.1) GNU General Public License v3.0 1.7K Commits 10 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Zeal

ChangelogGitterIRCTelegram ChannelTwitter

AppVeyorCoverity 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: * Report bugs and submit feature requests to GitHub issues. * Reach developers and other Zeal users on Gitter or IRC channel #zealdocs on Freenode. * Ask any questions in our Google Group. You can send an email to [email protected]. * Do not forget to follow @zealdocs on Twitter! * Finally, for private communications email us at [email protected].

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.