Offline documentation browser inspired by Dash
Go to file
Henning Schild 4bfa75abaa chore(cmake): force static linking of internal libs (#1085)
Since the application binary is the only file installed and the libs are
not used by anyone else, make sure they are always static. Otherwise
cmake can make them shared and those shared libs will be missing after
install.

Signed-off-by: Henning Schild <henning@hennsch.de>
2019-03-12 01:40:32 -04:00
.github chore(github): add CODEOWNERS file 2018-10-07 00:39:58 -04:00
assets assets: Add appstream metadata (#911) 2018-09-06 23:15:41 -04:00
cmake cmake: Parse SQLite version from sqlite3.h 2017-11-12 22:18:23 +02:00
src chore(cmake): force static linking of internal libs (#1085) 2019-03-12 01:40:32 -04:00
.appveyor.yml ci(appveyor): fix deployment condition 2019-03-03 18:13:00 -05:00
.editorconfig chore: add .editorconfig 2018-10-19 01:09:41 -04:00
.gitattributes Add *.woff to .gitattributes 2018-01-27 12:22:19 +02:00
.gitignore chore(git): update .gitignore 2018-10-19 01:15:24 -04:00
CHANGELOG.md doc: Add CHANGELOG.md pointing to GitHub Releases (closes #395) 2018-01-09 09:32:26 +02:00
CMakeLists.txt chore(cmake,doc): bump required Qt version to 5.9.5 2018-10-19 01:33:12 -04:00
COPYING README and COPYING 2013-01-20 01:49:25 +00:00
README.md chore(cmake,doc): bump required Qt version to 5.9.5 2018-10-19 01:33:12 -04:00

Zeal

Changelog Gitter IRC Telegram Channel Twitter

AppVeyor 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

Required dependencies

  • CMake.
  • Qt version 5.9.5 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.