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, поэтому вы скачиваете доксеты (упакованные наборы документации) и просматриваете их внутри приложения.
Нужно ли установить Qt, чтобы собрать или запустить программу?Да, Zeal построен на фреймворке Qt; для сборки из исходников нужны Qt и набор инструментов C++ вместе с Make.
Остаётся ли мой поиск приватным?Поскольку Zeal полностью работает офлайн с локальными доксетами, сетевых запросов не возникает, что полезно для личной или конфиденциальной работы.
Нужно ли Zeal подключение к интернету для работы?Нет, после загрузки доксетов программа рассчитана на полностью офлайн-работу.
Отправляет ли Zeal мои поисковые запросы куда-либо?Нет — он ищет по локальным доксетам на вашем компьютере и не требует подключения.
Зачем создали Zeal, если есть Dash?Dash работает только на macOS, поэтому Zeal создан как кроссплатформенная альтернатива (Linux/Windows/macOS), которая поддерживает тот же формат доксетов.
Могу ли я использовать свои существующие доксеты из Dash в Zeal?Да, Zeal поддерживает тот же формат, что и Dash, поэтому существующие доксеты можно загрузить напрямую.
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