mirror of https://github.com/zealdocs/zeal.git synced 2024-11-22 21:53:03 +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 756c8667c4 build(cmake): s/CERTIFICATE_PASSWORD/PASSWORD for codesign There are no other passwords, saves some typing.		2023-09-11 01:50:17 -04:00
.github	build(cmake): s/CERTIFICATE_PASSWORD/PASSWORD for codesign	2023-09-11 01:50:17 -04:00
assets	chore(assets): fix email address in AppStream metadata	2023-08-06 02:49:36 -04:00
cmake	build(cmake): s/CERTIFICATE_PASSWORD/PASSWORD for codesign	2023-09-11 01:50:17 -04:00
pkg	cmake(build): skip signing for source packaging	2023-09-11 01:17:10 -04:00
src	cmake(build): include OS and architecture in package name	2023-09-11 01:26:34 -04:00
.editorconfig	chore(editorconfig): add .json files	2022-07-23 18:08:06 -04:00
.gitattributes	chore: use recommended .yaml extension where possible (#1533 )	2023-09-08 00:54:02 -04:00
.gitignore	chore(gitignore): add vcpkg and vcpkg_install directories (#1492 )	2023-04-23 03:35:40 -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): cleanup variable use	2023-09-11 00:55:00 -04:00
CMakePresets.json	build(cmake): fix vcpkg dependency installation	2023-09-10 16:30:46 -04:00
COPYING	docs: fix insecure links	2020-06-29 00:26:14 -04:00
README.md	chore: use recommended .yaml extension where possible (#1533 )	2023-09-08 00:54:02 -04:00
vcpkg.json	build(vcpkg): add vulkan-headers dependency	2023-09-04 22:33:45 -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.