zeal README

The project's README from github.com/zealdocs/zeal. As one markdown file: README.md.

Zeal

Discord Telegram Channel X (Twitter)

Release Build Check License

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.

Zeal showing instant search results across multiple docsets

Download

Get it on Flathub Get it from the Snap Store

Binary builds for Windows and other installation options are available on the download page. Windows builds require Windows 10 version 1809 or later.

How to use

After installing Zeal, go to File → Docset Library, select the docsets you want, and click the Download button.

Query and filter docsets

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

Command line

You can also start Zeal with a query from the command line:

zeal python:pprint

How to compile

Detailed, up-to-date build instructions for each platform are available in the wiki. The bare minimum is described below.

Build dependencies

Build instructions

cmake --preset release
cmake --build --preset release

The resulting binary is build/release/zeal (zeal.exe on Windows).

Create your own docsets

Follow the instructions in the Dash docset generation guide.

Contributing

Contributions are welcome. See CONTRIBUTING.md for how to build Zeal, the conventions to follow, and what to expect from review.

Contact and support

Ways to get help or reach the developers:

License

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.

zeal (zealdocs/zeal)

desktop-application
Searching Database…

12.8K ·GitHub
What is this?Zeal is an offline documentation browser that acts as your personal reference library, letting you search programming docs instantly without an internet connection.
Is this a browser extension or a standalone desktop app?It is a standalone desktop application built with Qt/C++, not a browser plugin.
How do I get documentation into Zeal?Zeal uses the same docset format as Dash, so you download docsets (packaged documentation sets) and browse them inside the app.
Do I need Qt installed to build or run it?Yes, Zeal is built on the Qt framework; building from source requires Qt and a C++ toolchain with Make.
Is my search activity private?Since it works fully offline from local docsets, there's no network lookup involved, which is useful for anything private or sensitive.
Does Zeal require any internet connection to work?No, it's designed to work entirely offline once docsets are downloaded.
Does Zeal send my searches anywhere?No — it searches local docsets on your machine, with no connection required.
Why was Zeal created instead of just using Dash?Dash is macOS-only, so Zeal was built as a cross-platform (Linux/Windows/macOS) alternative that supports the same docset format.
Can I use my existing Dash docsets in Zeal?Yes, Zeal supports the same docset format as Dash, so existing docsets can be loaded directly.
Is Zeal actively maintained?The repo includes multiple active CI workflows (CodeQL analysis, Coverity scans, build checks, lint checks, OpenSSF Scorecard), suggesting ongoing maintenance.
What are similar projects?devdocs, jsdoc, redoc, pdfcraft, mdBook, keepassxc, ingetrazo, shotcut
Creator
zealdocs
Size
8.8 MB
Stars
12.8K
Age
13y
Commits · 90 Days