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)

Searching Database…

12.8K ·GitHub
这是什么?Zeal 是一款离线文档浏览器,相当于你的个人参考资料库,无需联网即可即时搜索编程文档。
这是浏览器扩展还是独立的桌面应用?它是基于 Qt/C++ 构建的独立桌面应用,不是浏览器插件。
我如何把文档导入 Zeal?Zeal 使用与 Dash 相同的 docset 格式,所以你只需下载 docset(打包好的文档集),然后在应用内浏览即可。
构建或运行它是否需要安装 Qt?需要。Zeal 基于 Qt 框架开发;从源码构建时,需要 Qt 以及带有 Make 的 C++ 工具链。
我的搜索记录是否保密?由于它完全基于本地 docset 离线工作,不涉及任何网络查询,因此很适合查询私密或敏感的内容。
Zeal 需要联网才能使用吗?不需要。docset 下载完成后,它的设计就是完全离线工作。
Zeal 会把我的搜索内容发送到别处吗?不会。它只搜索你电脑上的本地 docset,无需任何网络连接。
为什么要开发 Zeal,而不直接用 Dash?Dash 只能在 macOS 上使用,因此 Zeal 被开发为跨平台(Linux/Windows/macOS)的替代品,并且支持相同的 docset 格式。
我现有的 Dash docset 能在 Zeal 中使用吗?可以。Zeal 支持与 Dash 相同的 docset 格式,现有的 docset 可以直接加载。
Zeal 是否仍在积极维护?代码仓库包含多个正在运行的 CI 工作流(CodeQL 分析、Coverity 扫描、构建检查、代码检查、OpenSSF Scorecard),表明项目仍在持续维护。
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