Offline documentation browser inspired by Dash
Go to file
Andreas Sturmlechner bab39cd883
build(sidebar): add missing STATIC keyword (#1270)
Fixes unresolved soname dependency after install.

Signed-off-by: Andreas Sturmlechner <asturm@gentoo.org>
2020-08-18 23:09:19 -04:00
.github ci(github): build on Windows with Qt 5.15.0 2020-07-03 19:31:16 -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
pkg build(wix): bundle Universal C Runtime 2020-08-15 15:50:12 -04:00
src build(sidebar): add missing STATIC keyword (#1270) 2020-08-18 23:09:19 -04:00
.appveyor.yml ci(appveyor): fix packaging of 32-bit OpenSSL libraries one more time 2020-07-03 19:47:38 -04:00
.editorconfig chore: add .editorconfig 2018-10-19 01:09:41 -04:00
.gitattributes chore(git): fix .gitattributes 2020-08-15 15:25:18 -04:00
.gitignore build(wix): add WiX Toolset files 2020-08-15 14:29:31 -04:00
CHANGELOG.md doc: Add CHANGELOG.md pointing to GitHub Releases (closes #395) 2018-01-09 09:32:26 +02:00
CMakeLists.txt build(cmake): enable CMAKE_ERROR_DEPRECATED 2020-04-26 14:44:07 -04:00
COPYING docs: fix insecure links 2020-06-29 00:26:14 -04:00
README.md docs: cleanup readme 2020-07-07 00:09:49 -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

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:

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.