zealdocs/zeal
1
1
Fork 0
mirror of https://github.com/zealdocs/zeal.git synced 2024-11-26 15:43:49 +03:00
Code Issues Projects Releases Wiki Activity
Offline documentation browser inspired by Dash
1,829 Commits 6 Branches 13 Tags 7.3 MiB
C++ 96.2%
CMake 2.5%
HTML 0.8%
PowerShell 0.4%
2024915307
Go to file
Oleg Shparber 2024915307 fix(ui): do not intercept Alt+Left and Alt+Right 
These are reserved for back and forward browser actions.

Fixes #1531.
2023-09-07 00:58:17 -04:00
.github ci(github): bump actions/checkout from 3 to 4 (#1529) 2023-09-04 22:16:25 -04:00
assets chore(assets): fix email address in AppStream metadata 2023-08-06 02:49:36 -04:00
cmake build(cmake): do not hard-code default branch name 2023-03-18 23:23:03 -04:00
pkg build(appimage): update to Ubuntu 22.04 (#1472) 2023-03-18 22:16:48 -04:00
src fix(ui): do not intercept Alt+Left and Alt+Right 2023-09-07 00:58:17 -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 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): write calculated version to file 2023-03-20 02:23:57 -04:00
CMakePresets.json build(cmake): add basic build presets 2022-10-02 22:49:12 -04:00
COPYING docs: fix insecure links 2020-06-29 00:26:14 -04:00
README.md docs(readme): update contact information 2023-04-15 21:26:54 -04:00
vcpkg.json build(vcpkg): add vulkan-headers dependency 2023-09-04 22:33:45 -04:00

README.md

Zeal

Changelog Gitter IRC Telegram Channel Twitter

Build Check 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.