Zeal : documentation hors ligne au format docset de Dash
Navigateur de documentation hors ligne. Votre bibliothèque de référence personnelle, consultable en un instant.
En bref
- De quoi s’agit-il ?
- Un navigateur de documentation écrit en C++ qui stocke les docsets en local et les recherche sans connexion réseau.
- À qui s’adresse-t-il ?
- Zeal est un outil ciblé : il télécharge des docsets via la bibliothèque de docsets, les recherche localement avec des filtres préfixés par deux-points et accepte une requête en ligne de commande. Le chemin de compilation tient en deux préréglages CMake, et la licence est GPLv3 ou ultérieure.
- Puis-je l’utiliser commercialement ?
- Oui, sous conditions. GPL-3.0 est une licence copyleft : si vous distribuez un logiciel qui l’inclut, vous devez publier le code source de ce logiciel sous la même licence. Un usage interne, sans distribution, ne déclenche pas cette obligation.
- Est-il encore maintenu ?
- Oui. Les derniers commits datent d’il y a 6 jours.
- En quel langage est-il écrit ?
- Principalement C++, d’après les statistiques de langage de GitHub.
Ces réponses reposent sur les données GitHub du projet (dernière synchronisation le 14 septembre 2026) et sur notre analyse. Elles ne constituent pas un avis juridique.
ANALYSE OPEN SOURCE APPROFONDIE
Documentation hors ligne au format docset de Dash
Zeal est une application écrite en C++ qui fonctionne comme un navigateur de documentation hors ligne. L'idée centrale est que la documentation est stockée sur la machine locale, de sorte que la consultation ne dépend pas d'une connexion réseau ; le projet décrit le résultat comme une bibliothèque de référence personnelle, interrogeable instantanément. Le projet s'est initialement inspiré de Dash, un navigateur de documentation pour macOS, et prend en charge le même format docset que Dash. Cela signifie que les fichiers docset produits pour Dash peuvent être utilisés avec Zeal ; le README renvoie d'ailleurs au guide de génération de docsets de Dash pour quiconque souhaite créer ses propres docsets. Les métadonnées du dépôt enregistrent 12 745 étoiles, 833 forks et 104 issues ouvertes, bien que le README lui-même ne discute ni de popularité ni d'activité. Le README n'établit pas la taille d'un catalogue de docsets, ne liste pas les ensembles de documentation disponibles et ne mentionne pas l'importation de docsets depuis des fichiers locaux ; le seul flux de travail lié aux docsets qu'il documente consiste à sélectionner des docsets dans l'application et à les télécharger.
Canaux de téléchargement et exigences de plateforme
Zeal est distribué par plusieurs canaux. Le README affiche des badges pour Flathub et le Snap Store, ce qui couvre les utilisateurs Linux qui installent via ces magasins. Pour Windows, le README indique que des builds binaires sont disponibles sur la page de téléchargement du projet à zealdocs.org/download et que les builds Windows exigent Windows 10 version 1809 ou ultérieure. La page de téléchargement héberge également d'autres options d'installation, mais le README n'énumère pas lesquelles. Le README ne précise pas de version minimale de macOS, ne donne ni taille de fichier ni somme de contrôle pour aucun build et ne mentionne pas de gestionnaires de paquets tels que Homebrew ni de dépôts spécifiques aux distributions. Tout chemin d'installation au-delà de Flathub, du Snap Store et de la page de téléchargement Windows n'est pas établi par ce document.
Sélectionner des docsets et affiner une recherche
Après l'installation, le flux de travail documenté commence à la bibliothèque de docsets, accessible via le menu File. L'utilisateur sélectionne les docsets souhaités et clique sur le bouton Download. Une fois les docsets en place, la portée de la recherche peut être limitée en préfixant une requête avec un nom de docset et deux-points ; le README donne `cpp:vector` comme exemple. Pour rechercher plusieurs docsets à la fois, les noms sont séparés par des virgules, comme dans `python,django:string`. Zeal peut également être démarré avec une requête en ligne de commande ; le README montre `zeal python:pprint` comme invocation documentée. Ce flux de travail indique que l'utilisation quotidienne se déroule en deux étapes : d'abord télécharger les ensembles de documentation nécessaires via l'interface, puis saisir une requête avec préfixe limitant dans le champ de recherche. Le README ne décrit pas de raccourcis clavier, de classement des résultats, de correspondance floue ni de mise en œuvre de la recherche instantanée ; ces comportements ne sont donc pas établis par la documentation de ce dépôt.
Compiler depuis les sources avec CMake et Ninja
Le README indique que des instructions de compilation détaillées et à jour pour chaque plateforme se trouvent dans le wiki du projet et ne donne que le strict minimum pour compiler. Les dépendances de compilation sont CMake et Ninja, Qt version 6.4.2 ou ultérieure avec les modules Svg et WebEngine, libarchive et SQLite. Les plateformes Linux et BSD nécessitent en outre extra-cmake-modules ; les plateformes X11 uniquement nécessitent libxkbcommon et xcb-util-keysyms. La séquence de compilation documentée tient en deux commandes, `cmake --preset release` suivi de `cmake --build --preset release`, et le binaire résultant est écrit dans `build/release/zeal` (`zeal.exe` sous Windows). Le README ne spécifie pas de version minimale de compilateur, ne dit pas quelles versions mineures de Qt 6 au-delà de 6.4.2 ont été testées et ne décrit ni tests ni variante de build de débogage ; ces détails devraient être vérifiés dans le wiki.
Créer ses propres docsets et contribuer
Pour les utilisateurs qui souhaitent une documentation pas encore disponible sous forme de docset, le README renvoie au guide de génération de docsets de Dash sur kapeli.com/docsets plutôt que de documenter ses propres outils. Les contributeurs sont orientés vers CONTRIBUTING.md, qui, selon le README, couvre la façon de compiler Zeal, les conventions à suivre et ce à quoi s'attendre lors de la revue. Le README ne décrit pas le processus de contribution au-delà de ce fichier, ne nomme pas de normes de codage ou de règles de style spécifiques et ne dit pas ce que sont concrètement les attentes de la revue ; ces détails figurent dans CONTRIBUTING.md, qui ne fait pas partie du README. Le README ne mentionne pas non plus de gouvernance de projet, de structure de mainteneurs ni d'exigence d'accord de licence de contributeur.
Canaux d'assistance et conditions de licence
Le README liste six moyens d'obtenir de l'aide ou de joindre les développeurs : les issues GitHub pour les bogues et les demandes de fonctionnalités, les discussions GitHub pour les questions, un serveur Discord pour discuter avec les développeurs et d'autres utilisateurs, une chaîne Telegram pour les annonces, un compte X (@zealdocs) pour les nouvelles et les mises à jour, et une adresse e-mail (support@zealdocs.org) pour tout ce qui est privé ou sensible. Zeal est sous licence GNU General Public License version 3 (GPLv3) ou ultérieure ; le texte complet de la licence est dans le fichier COPYING et en ligne. Les composants tiers inclus sont sous leurs propres licences, et le dépôt est conforme à REUSE, tous les textes de licence étant disponibles dans le répertoire LICENSES. La licence accorde aux destinataires les droits de GPLv3 ou ultérieure, mais elle ne fournit aucune garantie ni obligation d'assistance, et le README n'en revendique aucune.
Conclusion éditoriale
Zeal est un outil ciblé : il télécharge des docsets via la bibliothèque de docsets, les recherche localement avec des filtres préfixés par deux-points et accepte une requête en ligne de commande. Le chemin de compilation tient en deux préréglages CMake, et la licence est GPLv3 ou ultérieure. Ce que le README ne couvre pas, notamment le classement des résultats, les raccourcis clavier, la taille du catalogue et la prise en charge de macOS, reste à vérifier.
Notes de la communauté