zealdocs/zeal
1
1
Fork 0
mirror of https://github.com/zealdocs/zeal.git synced 2024-11-30 03:13:56 +03:00
Code Issues Projects Releases Wiki Activity
Offline documentation browser inspired by Dash
323 Commits 6 Branches 13 Tags 7.3 MiB
C++ 96.2%
CMake 2.5%
HTML 0.8%
PowerShell 0.4%
61e20a9e7b
Go to file
Jerzy Kozera 61e20a9e7b Added missing .dll's to .drone.yml
2014-11-04 03:48:31 +00:00
gendocsets ExtJS: hopefully fixed ignoring empty files (not tested) 2014-04-29 15:58:42 +02:00
zeal Merge pull request #214 from spacewander/master 2014-11-03 21:05:59 +01:00
.drone.yml Added missing .dll's to .drone.yml 2014-11-04 03:48:31 +00:00
.gitignore add conflicted key binding name in the warning message 2014-11-03 00:26:38 +08:00
COPYING README and COPYING 2013-01-20 01:49:25 +00:00
docsets.txt Appcelerator Titanium 3.1.3 docset 2013-09-19 20:30:11 +02:00
README.md Adding support to multiple docsets query 2014-11-03 20:46:48 +01:00

README.md

Zeal

zeal
noun

  1. a feeling of strong eagerness (usually in favor of a person or cause)
  2. excessive fervor to do something or accomplish some end
  3. prompt willingness

(from WordNet 3.0)

Zeal is a simple documentation browser inspired by Dash.

Screenshot

More screenshots (imgur)

Download

For details about binary packages (currently available for Windows and Ubuntu) see downloads page.

How to use

After installing/compiling it you need to download docsets. It can be done automatically by clicking 'Edit', 'Options', 'Docsets', 'Download...'.

How to compile

If you prefer to compile Zeal manually.

Requirements

  • Qt 5.0
  • X C Binding – keysyms (Ubuntu libxcb-keysyms1-dev)
  • bsdtar is required for the built-in docset extracting to work
  • libappindicator and libappindicator-devel for notifications
  • you may need to install libqt5webkit5-dev and qtbase5-private-dev

To compile it, run qmake and make in the zeal directory. On Linux, a final make install is required to install icons.

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 with Zeal queries from command line, for this, use the option --query:

zeal --query python:bomb

TODO

  • Issues
  • Search enhancements - some ideas:
    • Allow selecting subset of docsets to search in (enable/disable docsets, docset groups)
    • Grouping of similar results (like overloaded functions)
  • Code cleanup
    • Refactoring to reuse common code between ZealDocsetsRegistry and ZealListModel
    • ...

Creating your own docsets

You can use Dash's instructions for generating docsets.

Contributions / Project Status

Any feedback, feature requests, or pull requests are welcome. However the project is not under active development at the moment, so unless someone is interested in contributing code, no new features are expected.

I'm going to continue updating docsets that are part of Dash/Zeal exchange programme, and try to fix critical stability/compatibility issues if any arise, to keep the project somewhat alive, but will not implement new features in foreseeable future. Anyway, I should be able to review pull requests.

Please keep in mind I'm not an experienced C++ programmer, so the code quality might be not great.