mirror of https://github.com/zealdocs/zeal.git synced 2024-11-22 12:33:20 +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

guihkx 87f9448168 chore(assets): add missing 'launchable' tag in Linux metadata Fixes a validation error given by appstreamcli: $ appstreamcli validate org.zealdocs.zeal.appdata.xml E: org.zealdocs.zeal:~: desktop-app-launchable-missing https://www.freedesktop.org/software/appstream/docs/chap-Validation.html#asv-desktop-app-launchable-missing		2024-02-25 12:16:24 -05:00
.github	ci(github): validate AppStream metadata	2024-02-19 11:10:42 -05:00
assets	chore(assets): add missing 'launchable' tag in Linux metadata	2024-02-25 12:16:24 -05:00
cmake	build(cmake): add support for base64-encoded signing certificate	2023-09-19 03:07:19 -04:00
pkg	ci(github): validate AppStream metadata	2024-02-19 11:10:42 -05:00
src	refactor: replace deprecated qAsConst with std::as_const() (#1565 )	2023-10-29 02:50:40 -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.