mirror of https://github.com/zealdocs/zeal.git synced 2024-07-14 17:40:31 +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 f2212eb4f0 fix(browser): send key events to web view's focus proxy Fixes regression introduced by migration to Qt WebEngine, which caused search toolbar not to propagate navigation keys to the web view. Related to #703.		2023-10-05 03:32:13 -04:00
.github	ci(github): add release workflow	2023-09-20 01:23:44 -04:00
assets	chore: bump version to 0.7.0	2023-09-20 01:24:18 -04:00
cmake	build(cmake): add support for base64-encoded signing certificate	2023-09-19 03:07:19 -04:00
pkg	chore: bump version to 0.7.1	2023-10-01 22:28:14 -04:00
src	fix(browser): send key events to web view's focus proxy	2023-10-05 03:32:13 -04:00
.editorconfig	chore: update .editorconfig	2023-09-18 02:30:10 -04:00
.gitattributes	chore: use recommended .yaml extension where possible (#1533 )	2023-09-08 00:54:02 -04:00
.gitignore	chore: cleanup .gitignore	2023-09-18 02:29:01 -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: bump version to 0.7.1	2023-10-01 22:28:14 -04:00
CMakePresets.json	build(cmake): check ZEAL_RELEASE_BUILD environment variable	2023-09-18 01:51:59 -04:00
COPYING	docs: fix insecure links	2020-06-29 00:26:14 -04:00
README.md	docs(readme): update screenshot	2023-09-18 03:44:15 -04:00
vcpkg.json	chore: bump version to 0.7.1	2023-10-01 22:28:14 -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 in #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 support@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.