mirror of https://github.com/zealdocs/zeal.git synced 2024-11-23 14:26:12 +03:00

Offline documentation browser inspired by Dash

api api-documentation dash desktop-application developer-tools docs docset documentation documentation-tool offline starred-repo starred-zealdocs-repo zeal

Go to file

Oleg Shparber 72b254bb18 ui: Remove About Qt menu item Attribution to Qt is now available in the About dialog.		2018-01-08 00:42:51 +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	ui: Remove About Qt menu item	2018-01-08 00:42:51 +02:00
.gitattributes	Add .gitattributes	2017-03-30 00:03:46 -04: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
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: Remove build info for the stable branch in README	2018-01-04 02:13:11 +02:00

README.md

Zeal

Zeal is a simple offline documentation browser inspired by Dash.

More screenshots

Build Status

OS	Build Status
Linux
Windows

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:

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 simply send an email to zealdocs@googlegroups.com.
Finally, for private communications email us at zeal@zealdocs.org.
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.