{"id":13392969,"url":"https://github.com/zealdocs/zeal","last_synced_at":"2026-10-18T22:06:53.729Z","repository":{"id":6471549,"uuid":"7711472","full_name":"zealdocs/zeal","owner":"zealdocs","description":"Offline documentation browser. Your personal reference library, searchable in an instant.","archived":false,"fork":false,"pushed_at":"2026-09-29T12:04:47.000Z","size":9035,"stargazers_count":12817,"open_issues_count":106,"forks_count":845,"subscribers_count":199,"default_branch":"main","last_synced_at":"2026-10-04T11:45:00.006Z","etag":null,"topics":["api","api-documentation","dash","desktop-application","developer-tools","docs","docset","documentation","documentation-tool","linux","offline","qt","reference","windows","zeal"],"latest_commit_sha":null,"homepage":"https://zealdocs.org","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zealdocs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"claude":null,"gemini":null,"cursor":null,"copilot":null,"dco":null,"cla":null,"disclosure":null}},"created_at":"2013-01-20T01:50:30.000Z","updated_at":"2026-10-04T11:13:04.000Z","dependencies_parsed_at":"2026-09-07T02:04:42.574Z","dependency_job_id":"62565eca-030c-4121-bd2a-cd21b6f203b4","html_url":"https://github.com/zealdocs/zeal","commit_stats":{"total_commits":1822,"total_committers":79,"mean_commits":"23.063291139240505","dds":"0.36169045005488476","last_synced_commit":"66b30331f84a0081cbaa8955f92c8e42a990a1ca"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/zealdocs/zeal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealdocs%2Fzeal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealdocs%2Fzeal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealdocs%2Fzeal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealdocs%2Fzeal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zealdocs","download_url":"https://codeload.github.com/zealdocs/zeal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zealdocs%2Fzeal/sbom","scorecard":{"id":1236549,"data":{"date":"2025-08-18","repo":{"name":"github.com/zealdocs/zeal","commit":"5603f0596425553a655d1365978f1c228ccee47a"},"scorecard":{"version":"v5.2.1-41-g40576783","commit":"40576783fda6698350fcbbeaea760ff827433034"},"score":4.4,"checks":[{"name":"Code-Review","score":0,"reason":"Found 2/29 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":1,"reason":"1 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/analyze-codeql.yaml:1","Warn: no topLevel permission defined: .github/workflows/analyze-coverity.yaml:1","Warn: no topLevel permission defined: .github/workflows/build-check.yaml:1","Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yaml:10","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#binary-artifacts"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: COPYING:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: COPYING:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#fuzzing"}},{"name":"CII-Best-Practices","score":2,"reason":"badge detected: InProgress","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#cii-best-practices"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.7.2 not signed: https://api.github.com/repos/zealdocs/zeal/releases/174020695","Warn: release artifact v0.7.1 not signed: https://api.github.com/repos/zealdocs/zeal/releases/157691817","Warn: release artifact v0.7.0 not signed: https://api.github.com/repos/zealdocs/zeal/releases/121814147","Warn: release artifact v0.6.1 not signed: https://api.github.com/repos/zealdocs/zeal/releases/13142880","Warn: release artifact v0.6.0 not signed: https://api.github.com/repos/zealdocs/zeal/releases/9722229","Warn: release artifact v0.7.2 does not have provenance: https://api.github.com/repos/zealdocs/zeal/releases/174020695","Warn: release artifact v0.7.1 does not have provenance: https://api.github.com/repos/zealdocs/zeal/releases/157691817","Warn: release artifact v0.7.0 does not have provenance: https://api.github.com/repos/zealdocs/zeal/releases/121814147","Warn: release artifact v0.6.1 does not have provenance: https://api.github.com/repos/zealdocs/zeal/releases/13142880","Warn: release artifact v0.6.0 does not have provenance: https://api.github.com/repos/zealdocs/zeal/releases/9722229"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#signed-releases"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/analyze-codeql.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-codeql.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/analyze-codeql.yaml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-codeql.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/analyze-codeql.yaml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-codeql.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/analyze-codeql.yaml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-codeql.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/analyze-coverity.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-coverity.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/analyze-coverity.yaml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-coverity.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/analyze-coverity.yaml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/analyze-coverity.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-check.yaml:186: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-check.yaml:208: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-check.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-check.yaml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-check.yaml:124: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-check.yaml:129: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-check.yaml:135: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-check.yaml:144: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-check.yaml:164: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-check.yaml:173: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/build-check.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/lock.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:101: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:152: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:170: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:177: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yaml:186: update your workflow using https://app.stepsecurity.io/secureworkflow/zealdocs/zeal/release.yaml/main?enable=pin","Warn: containerImage not pinned by hash: .github/workflows/appimage/Dockerfile:1: pin your Docker image by updating ubuntu:jammy to ubuntu:jammy@sha256:1aa979d85661c488ce030ac292876cf6ed04535d3a237e49f61542d8e5de5ae0","Warn: pipCommand not pinned by hash: .github/workflows/appimage/Dockerfile:3-21","Info:   0 out of  14 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of  15 third-party GitHubAction dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   1 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#pinned-dependencies"}},{"name":"Branch-Protection","score":6,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Info: codeowner review is required on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: SAST configuration detected: CodeQL","Info: all commits (5) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/40576783fda6698350fcbbeaea760ff827433034/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-31T01:12:35.331Z","repository_id":6471549,"created_at":"2025-08-31T01:12:35.331Z","updated_at":"2025-08-31T01:12:35.331Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38342694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-documentation","dash","desktop-application","developer-tools","docs","docset","documentation","documentation-tool","linux","offline","qt","reference","windows","zeal"],"created_at":"2024-07-30T17:00:40.290Z","updated_at":"2026-10-18T22:06:53.724Z","avatar_url":"https://github.com/zealdocs.png","language":"C++","funding_links":[],"categories":["C++","Others","Applications","\u003ca name=\"cpp\"\u003e\u003c/a\u003eC++","应用","api","Uncategorized","Documentation Types"],"sub_categories":["Development","开发","Uncategorized","API Documentation"],"readme":"# Zeal\n\n[![Discord](https://img.shields.io/badge/chat-on%20discord-5865f2?style=flat-square)](https://go.zealdocs.org/l/discord)\n[![Telegram Channel](https://img.shields.io/badge/follow-on%20telegram-179cde?style=flat-square)](https://go.zealdocs.org/l/telegram)\n[![X (Twitter)](https://img.shields.io/badge/follow-on%20x-000000?style=flat-square)](https://go.zealdocs.org/l/x)\n\n[![Release](https://img.shields.io/github/release/zealdocs/zeal?style=flat-square)](https://github.com/zealdocs/zeal/releases)\n[![Build Check](https://img.shields.io/github/actions/workflow/status/zealdocs/zeal/build-check.yaml?style=flat-square)](https://github.com/zealdocs/zeal/actions/workflows/build-check.yaml)\n[![License](https://img.shields.io/github/license/zealdocs/zeal?style=flat-square)](COPYING)\n\nZeal is an offline documentation browser: your personal reference library, searchable in an instant and available\nwithout a connection. Originally inspired by [Dash](https://kapeli.com/dash), it supports the same docset format.\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\"\n    srcset=\"https://raw.githubusercontent.com/zealdocs/media/main/screenshots/windows/readme-dark.png\"\u003e\n  \u003cimg alt=\"Zeal showing instant search results across multiple docsets\"\n    src=\"https://raw.githubusercontent.com/zealdocs/media/main/screenshots/windows/readme-light.png\"\u003e\n\u003c/picture\u003e\n\n## Download\n\n\u003ca href=\"https://flathub.org/apps/org.zealdocs.Zeal\"\u003e\u003cimg height=\"44\" alt=\"Get it on Flathub\"\n  src=\"https://flathub.org/api/badge?svg\u0026amp;locale=en\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://snapcraft.io/zeal\"\u003e\u003cimg height=\"44\" alt=\"Get it from the Snap Store\"\n  src=\"https://snapcraft.io/static/images/badges/en/snap-store-black.svg\"/\u003e\u003c/a\u003e\n\nBinary builds for Windows and other installation options are available on the\n[download page](https://zealdocs.org/download). Windows builds require Windows 10 version 1809 or later.\n\n## How to use\n\nAfter installing Zeal, go to `File → Docset Library`, select the docsets you want, and click the `Download` button.\n\n### Query and filter docsets\n\nLimit the search scope by prefixing your query with a docset name and a colon:\n\n`cpp:vector`\n\nTo search multiple docsets, separate them with a comma:\n\n`python,django:string`\n\n### Command line\n\nYou can also start Zeal with a query from the command line:\n\n`zeal python:pprint`\n\n## How to compile\n\nDetailed, up-to-date build instructions for each platform are available in the\n[wiki](https://github.com/zealdocs/zeal/wiki). The bare minimum is described below.\n\n### Build dependencies\n\n* [CMake](https://cmake.org/) and [Ninja](https://ninja-build.org/).\n* [Qt](https://www.qt.io/) version 6.4.2 or later. Required modules besides Qt Base: Svg, WebEngine.\n* [libarchive](https://libarchive.org/).\n* [SQLite](https://sqlite.org/) version 3.31.0 or later.\n* Linux/BSD platforms: `extra-cmake-modules`.\n* X11 platforms only: `libxkbcommon`, `xcb-util-keysyms`.\n\n### Build instructions\n\n```shell\ncmake --preset release\ncmake --build --preset release\n```\n\nThe resulting binary is `build/release/zeal` (`zeal.exe` on Windows).\n\n## Create your own docsets\n\nFollow the instructions in the [Dash docset generation guide](https://kapeli.com/docsets).\n\n## Contributing\n\nContributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for how to build Zeal, the conventions to follow,\nand what to expect from review.\n\n## Contact and support\n\nWays to get help or reach the developers:\n\n* Report bugs and submit feature requests to [GitHub issues](https://github.com/zealdocs/zeal/issues).\n* Ask questions in [GitHub discussions](https://github.com/zealdocs/zeal/discussions).\n* Chat with the developers and other Zeal users on [Discord](https://go.zealdocs.org/l/discord).\n* Subscribe to the [Telegram channel](https://go.zealdocs.org/l/telegram) for announcements.\n* Follow [@zealdocs](https://go.zealdocs.org/l/x) on X for news and updates.\n* Email \u003csupport@zealdocs.org\u003e for anything private or sensitive.\n\n## License\n\nThis software is licensed under the terms of the GNU General Public License version 3 (GPLv3) or later. Full text of\nthe license is available in the [COPYING](COPYING) file and [online](https://www.gnu.org/licenses/gpl-3.0.html).\n\nBundled third-party components are licensed under their respective terms; the repository is\n[REUSE](https://reuse.software/)-compliant, with all license texts available in the [LICENSES](LICENSES) directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzealdocs%2Fzeal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzealdocs%2Fzeal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzealdocs%2Fzeal/lists"}