All Projects → zealdocs → Zeal

zealdocs / Zeal

Licence: gpl-3.0
Offline documentation browser inspired by Dash

Programming Languages

C++
36643 projects - #6 most used programming language
CMake
9771 projects
HTML
75241 projects
powershell
5483 projects
Dockerfile
14818 projects
CSS
56736 projects

Projects that are alternatives of or similar to Zeal

Devdocs
API Documentation Browser
Stars: ✭ 27,208 (+196.9%)
Mutual labels:  api-documentation, documentation, docs, documentation-tool, developer-tools, offline
Pdoc
API Documentation for Python Projects
Stars: ✭ 853 (-90.69%)
Mutual labels:  api, api-documentation, documentation, docs, documentation-tool
Doc Browser
A documentation browser with support for DevDocs, Dash and Hoogle, written in Haskell and QML
Stars: ✭ 93 (-98.99%)
Mutual labels:  api-documentation, documentation-tool, dash, developer-tools
Hexo Theme Doc
A documentation theme for the Hexo blog framework
Stars: ✭ 222 (-97.58%)
Mutual labels:  api, api-documentation, documentation, documentation-tool
Pdoc
🐍 ➡️ 📜 Auto-generate API documentation for Python projects
Stars: ✭ 604 (-93.41%)
Mutual labels:  api-documentation, documentation, docs, documentation-tool
Drf Autodocs
Ultimately automated DRF documentation rendering(UNMAINTAINED)
Stars: ✭ 82 (-99.11%)
Mutual labels:  api, api-documentation, documentation, documentation-tool
Awesome Documentation Tools
🔥 📚 All the tools, processes and resources you need to create an awesome API & Project documentation
Stars: ✭ 138 (-98.49%)
Mutual labels:  api, api-documentation, documentation, documentation-tool
Devdocs Macos
An unofficial DevDocs API Documentation viewer for macOS.
Stars: ✭ 258 (-97.18%)
Mutual labels:  documentation, documentation-tool, developer-tools
Docma
A powerful tool to easily generate beautiful HTML documentation from JavaScript (JSDoc), Markdown and HTML files.
Stars: ✭ 287 (-96.87%)
Mutual labels:  api, documentation, docs
Dash Docset Builder
Dash Docset Builder in PHP.
Stars: ✭ 54 (-99.41%)
Mutual labels:  documentation, dash, offline
Verb
HEADS UP! Verb is going though a major transition, we've completely refactored everything from the ground up. If you're interested, please see the dev branch.
Stars: ✭ 442 (-95.18%)
Mutual labels:  api, documentation, docs
Cljdoc
📚 A central documentation hub for the Clojure community
Stars: ✭ 416 (-95.46%)
Mutual labels:  api, documentation, docs
Jsdoc Baseline
An experimental, extensible template for JSDoc.
Stars: ✭ 51 (-99.44%)
Mutual labels:  api, documentation, docs
zeal-user-contrib
A convenient CLI to add Dash's User Contributed docsets to Zeal
Stars: ✭ 49 (-99.47%)
Mutual labels:  dash, docset, zeal
chappe
🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.
Stars: ✭ 132 (-98.56%)
Mutual labels:  docs, api-documentation, documentation-tool
Docsify
🃏 A magical documentation site generator.
Stars: ✭ 19,310 (+110.72%)
Mutual labels:  documentation, docs, documentation-tool
maya cpp reference docset
Dash-compatible docset for the Maya C++ API reference.
Stars: ✭ 19 (-99.79%)
Mutual labels:  dash, docset, zeal
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (-53.01%)
Mutual labels:  documentation, docs, documentation-tool
Platform Documentation
Core Platform API Documentation & Tutorials
Stars: ✭ 25 (-99.73%)
Mutual labels:  api, api-documentation, documentation
Jsdoc
An API documentation generator for JavaScript.
Stars: ✭ 12,555 (+37%)
Mutual labels:  api, documentation, docs

Zeal

Changelog Gitter IRC Telegram Channel Twitter

Build Check Coverity Scan

Zeal is a simple offline documentation browser inspired by Dash.

Screenshot

Download

Get binary builds for Windows and Linux from the download page.

How to use

After installing Zeal go to Tools->Docsets, select the ones you want, and click the Download button.

How to compile

Build dependencies

  • CMake.
  • Qt version 5.9.5 or above. Required module: Qt WebEngine Widgets.
  • libarchive.
  • SQLite.
  • X11 platforms only: Qt X11 Extras and xcb-util-keysyms.

Build instructions

cmake -B build
cmake --build build

More detailed instructions are available in the wiki.

Query & Filter docsets

You can limit the search scope by using ':' to indicate the desired docsets:

java:BaseDAO

You can also search multiple docsets separating them with a comma:

python,django:string

Command line

If you prefer, you can start Zeal with a query from the command line:

zeal python:pprint

Create your own docsets

Follow instructions in the Dash docset generation guide.

Contact and Support

We want your feedback! Here's a list of different ways to contact developers and request help:

License

This software is licensed under the terms of the GNU General Public License version 3 (GPLv3). Full text of the license is available in the COPYING file and online.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].