zealdocs/zeal
1
1
Fork 0
mirror of https://github.com/zealdocs/zeal.git synced 2024-09-17 17:27:56 +03:00
Code Issues Projects Releases Wiki Activity
Offline documentation browser inspired by Dash
19 Commits 6 Branches 13 Tags 7.1 MiB
C++ 96.2%
CMake 2.5%
HTML 0.8%
PowerShell 0.4%
11a1eb5dd0
Go to file
Jerzy Kozera 11a1eb5dd0 Added Ctrl+F searching in current document
2013-01-26 16:03:12 +00:00
gendocsets Added 'clear' button to search box, fixed py273 docset 2013-01-26 01:47:44 +00:00
zeal Added Ctrl+F searching in current document 2013-01-26 16:03:12 +00:00
.gitignore Initial commit - prototype search for multiple docsets 2013-01-19 21:42:42 +00:00
COPYING README and COPYING 2013-01-20 01:49:25 +00:00
README.md Added Ctrl+F searching in current document 2013-01-26 16:03:12 +00: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, but designed from scratch to avoid copyright issues.

Screenshots (imgur)

How to use

After compiling/unzipping it you need to download docsets and put them in $HOME/.local/share/zeal/docsets/ (Linux) or C:\Users\[your username]\AppData\Local\zeal\docsets\ (Windows) -- after creating the directory first. Currently there are docsets available from Qt 5 and Python 2.7.3, generated using scripts from gendoctests directory, but for convenience can be downloaded from Dropbox:

Do tar -jxvf file.tar.bz2 in docsets directory to enable given docset.

How to compile

Currently Zeal requires Qt 5.0. To compile it, run qmake and make in the zeal directory.

Windows binary

A windows binary with all dependencies is available to download from Dropbox - zeal.zip (23M).

TODO

  • Configuration (customisable hotkey instead of hardcoded Alt+Space, remember window size, etc.)
  • Support for global hotkeys under platforms other than Linux/X11 and Windows (OSX)
  • Search enhancements - some ideas:
    1. Allow selecting subset of docsets to search in.
    2. Substring match in case current startswith matching doesn't return anything.
    3. Grouping of similar results (like overloaded functions)
    4. Better docsets formatting (without headers, sidebars etc.)
  • More docsets

Contributions

Any feedback, feature requests, or pull requests are welcome. Before starting to implement anything larger, especially items from the TODO list above, it would be good to contact me at jerzy dot kozera at gmail, to avoid duplicating work.

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

Also you can send bitcoins to 1Zea1QhPV5CGp8SNMpb2RHUvRrfNhKqGV to encourage development.