Skip to content
/ zeal Public
forked from zealdocs/zeal

Simple API documentation browser inspired by Dash

License

Notifications You must be signed in to change notification settings

rowhit/zeal

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zeal

Build Status AppVeyor Coverity Scan IRC

zeal noun

  1. a feeling of strong eagerness (usually in favor of a person or cause)
  2. excessive fervor to do something or accomplish some end
  3. prompt willingness

(from WordNet 3.0)

Zeal is a simple offline documentation browser inspired by Dash.

Screenshot

More screenshots

Download

For details about binary packages (currently available for Windows and Ubuntu) see downloads page. Also, the latest unstable builds are available here.

How to use

After installing Zeal, you need to download docsets. Go to File->Options->Docsets, select the ones you want, and click the Download button.

How to compile

If you prefer to compile Zeal manually.

Requirements

To compile it, run qmake and make.

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 command line:

zeal python:bomb

Creating your own docsets

You can use Dash's instructions for generating docsets.

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.
  • Ask any questions in our Google Group. You can simply send an email to zealdocs@googlegroups.com.
  • For a quick chat with developers and other Zeal users use our IRC channel: #zealdocs on Freenode. Also available through Kiwi IRC web interface. Please, take into consideration possible time zone differences.
  • Finally, for a private communications send us email.
  • And do not forget to follow @zealdocs on Twitter!

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

Simple API documentation browser inspired by Dash

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 97.3%
  • QMake 1.5%
  • Other 1.2%