mirror of https://github.com/zealdocs/zeal.git synced 2024-11-26 07:37:15 +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 b5cb74ea2b fix(ui): fix typo		2022-07-23 18:13:03 -04:00
.github	chore(github): disable Dependabot pull request label	2022-07-23 15:02:49 -04:00
assets	build(cmake): add versioning for unstable builds	2021-01-24 12:42:49 -05:00
cmake	build(cmake): detect shallow clone, log failed Git checks	2021-01-30 13:51:42 -05:00
pkg	build(appimage): bundle qt5-gtk-platformtheme	2021-07-18 01:33:58 -04:00
src	fix(ui): fix typo	2022-07-23 18:13:03 -04:00
.editorconfig	chore(editorconfig): add .json files	2022-07-23 18:08:06 -04:00
.gitattributes	chore(git): fix .gitattributes	2020-08-15 15:25:18 -04:00
.gitignore	fix(assets): update AppStream ID to org.zealdocs.zeal	2021-01-24 12:42:49 -05: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): bump minimum CMake version to 3.16.3	2022-04-16 10:26:45 -07:00
CMakePresets.json	build(cmake): add CMakePresets.json (#1410 )	2022-07-23 13:15:48 -04:00
COPYING	docs: fix insecure links	2020-06-29 00:26:14 -04:00
README.md	docs: update contact information	2021-07-18 00:46:36 -04:00
vcpkg.json	build(cmake): add CMakePresets.json (#1410 )	2022-07-23 13:15:48 -04:00

README.md

Zeal

Zeal is a simple offline documentation browser inspired by Dash.

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:

Report bugs and submit feature requests to GitHub issues.
Reach developers and other Zeal users on Gitter or #zealdocs IRC channel on Libera Chat (web client).
Ask any questions in our GitHub Discussions.
Do not forget to follow @zealdocs on Twitter!
Finally, for private communication shoot an email to zeal@zealdocs.org.

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.