Offline documentation browser. Your personal reference library, searchable in an instant.
Offline documentation browser. Your personal reference library, searchable in an instant.
Zeal is an offline documentation browser: your personal reference library, searchable in an instant and available without a connection. Originally inspired by Dash, it supports the same docset format.
Binary builds for Windows and other installation options are available on the download page. Windows builds require Windows 10 version 1809 or later.
After installing Zeal, go to File → Docset Library, select the docsets you want, and click the Download button.
Limit the search scope by prefixing your query with a docset name and a colon:
cpp:vector
To search multiple docsets, separate them with a comma:
python,django:string
You can also start Zeal with a query from the command line:
zeal python:pprint
Detailed, up-to-date build instructions for each platform are available in the wiki. The bare minimum is described below.
extra-cmake-modules.libxkbcommon, xcb-util-keysyms.cmake --preset release
cmake --build --preset release
The resulting binary is build/release/zeal (zeal.exe on Windows).
Follow the instructions in the Dash docset generation guide.
Contributions are welcome. See CONTRIBUTING.md for how to build Zeal, the conventions to follow, and what to expect from review.
Ways to get help or reach the developers:
This software is licensed under the terms of the GNU General Public License version 3 (GPLv3) or later. Full text of the license is available in the COPYING file and online.
Bundled third-party components are licensed under their respective terms; the repository is REUSE-compliant, with all license texts available in the LICENSES directory.
No open issues yet, or sync has not completed.