A Ulauncher extension to query the Zeal offline documentation browser.
- Show installed Zeal docsets with their icons
- Fuzzy filtering of docsets
- Open the Zeal app with the specified docset and search query
Note: the extension cannot show actual search results because as of this writing, Zeal doesn't have an actual search API. The only way to interact with Zeal is to pass the docset name and the query to it via the command line. Issue #1 is all about this.
Why use this instead of the Zeal's global shortcut?
- If you already use Ulauncher for other things, there's no need to define and learn a separate keyboard shortcut for Zeal
- The fuzzy docset keyword matching in Ulauncher could sometimes maybe require less keystrokes than "call up Zeal, start typing docset name, press Tab, start typing query"
I know, it's not much. I guess I just like Ulauncher :-)
- Install Zeal
Open Ulauncher preferences window -> Extensions -> "Add extension" and paste the following url:
https://github.com/pbkhrv/ulauncher-zeal
Zeal docsets path: path to where your installation of Zeal stores the downloaded docsets. The default works on Ubuntu with Zeal installed thru apt, but your mileage may vary. Check Zeal -> Preferences -> General -> Docset storage.
Open Ulauncher and type in "zl " to start the extension. If everything is configured correctly, you'll see the list of your downloaded Zeal docsets:
The first argument is the docset keyword. It filters the list of docsets down to whatever matches the keyword:
The second argument is the search query that'll be passed to Zeal:
Press Enter to open Zeal with that keyword and query:
Please install wmctrl - it's a utility that ulauncher-zeal calls to "activate" the Zeal window and bring it to the foreground after sending the docset query to it:
Ubuntu and Debian
sudo apt-get install wmctrlI use the following tools while working on this extension:
Blackcode formatterpytestpylintwith theflake8pluginmypystatic type checker
You can install them in one shot (except for Black - that's up to you) by running:
pip install -r scripts/requirements.txtCheck PEP8 compliance, perform static type analysis and run unit tests:
make testBackup the "production" version of the extension and symlink the development version into Ulauncher's extension directory:
make symlinkQuit Ulauncher. Then run it in debug mode:
make run_ulRun extension in the terminal, connect it to Ulauncher in debug mode:
make run(if that doesn't work, check the connection string URL printed out by Ulauncher and modify the Makefile accordingly.)
Unlink the development version of the extension from Ulauncher and replace it with whatever was there before:
make unlinkIssues and pull requests are welcome!
I loved Alfred on MacOS, and now I love Ulauncher on Linux. The Python API is a joy to work with.
Thanks to Dash for MacOS and the Zeal project for making awesome offline documentation easily available.
MIT license. See LICENSE file for details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent