Offline documentation browser inspired by Dash
Go to file
2018-02-09 00:14:23 +02:00
assets qmake: Remove qmake support 2017-12-17 17:56:56 +02:00
cmake cmake: Parse SQLite version from sqlite3.h 2017-11-12 22:18:23 +02:00
src registry: Exclude all keywords containing 'dashtoc' 2018-02-09 00:14:23 +02:00
.gitattributes Add *.woff to .gitattributes 2018-01-27 12:22:19 +02:00
.gitignore cmake: Introduce CMake-based build option 2017-02-19 21:09:24 -05:00
.shippable.yml ci[shippable]: Install CMake 2017-04-11 08:46:55 -04:00
CHANGELOG.md doc: Add CHANGELOG.md pointing to GitHub Releases (closes #395) 2018-01-09 09:32:26 +02:00
CMakeLists.txt cmake: Require Qt version >= 5.5.1 2018-01-07 17:10:44 +02:00
COPYING README and COPYING 2013-01-20 01:49:25 +00:00
README.md doc: Update the screenshot in README 2018-01-22 01:05:20 +02:00

Zeal

Changelog Gitter IRC Telegram Channel Twitter

Zeal is a simple offline documentation browser inspired by Dash.

Screenshot

Build Status

Coverity Scan

OS Build Status
Linux Shippable
Windows AppVeyor

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.5.1 or above. Required module: Qt WebKit 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:

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.