About this project

Zeal is a desktop application for browsing documentation offline. It presents itself as a personal reference library that can be searched instantly and used without a connection. Its design was originally inspired by Dash, and it reads the same docset format, so existing Dash docsets are usable. Getting started: after installation you open File → Docset Library, choose the docsets you need and click Download. Downloaded docsets remain on the local machine and are used for lookup. Search behaviour: the search scope can be narrowed by prefixing a query with a docset name followed by a colon, for example cpp:vector. Several docsets can be searched at once by separating their names with commas, for example python,django:string. Zeal can also be launched with a query from the command line, such as zeal python:pprint. Distribution: the project is published on Flathub (org.zealdocs.Zeal) and the Snap Store, and binary builds for Windows plus other installation options are listed on the project's download page. The README states that Windows builds require Windows 10 version 1809 or later. Building from source: the README points to the project wiki for up-to-date per-platform instructions, and gives a minimal overview. It lists as build dependencies CMake, Ninja, Qt 6.4.2 or later (with the Svg and WebEngine modules in addition to Qt Base), libarchive and SQLite; Linux and BSD platforms additionally need extra-cmake-modules, and X11 platforms need libxkbcommon and xcb-util-keysyms. The documented build steps are the CMake presets cmake --preset release followed by cmake --build --preset release, producing build/release/zeal (zeal.exe on Windows). Docsets of your own can be created by following the Dash docset generation guide. Contributions are welcomed through the repository's CONTRIBUTING.md, which describes how to build the project, conventions to follow and what to expect from review. Support and contact options listed in the README include GitHub issues for bugs and feature requests, GitHub discussions for questions, Discord for chat with developers and other users, a Telegram channel for announcements, the @zealdocs account on X for news, and an email address for private or sensitive matters. Licensing: Zeal is distributed under the GNU General Public License version 3 or later, with the full text in the COPYING file. Bundled third-party components keep their own licenses, and the repository is stated to be REUSE-compliant with all license texts stored in the LICENSES directory.