Skip to content
Ulauncher extension to search documentation on DevDocs
Python Makefile
Branch: master
Clone or download

README.md

ulauncher-devdocs

Build Status GitHub license

Ulauncher extension to search documentation on DevDocs

Demo

demo.gif

Requirements

  • Ulauncher >5
  • Python >= 3

Install

Open ulauncher preferences window -> extensions -> add extension and paste the following url:

https://github.com/brpaz/ulauncher-devdocs

Usage

Basic configuration

The first thing you need to do is to Open Extension preferences and configure the "List of Documentation to Download". The value of this input needs to be a valid JSON array containing the "slug" of the documentation pages you want to download. You can get the "slug" by opening the desired documentation page in your browser and look at the value in the url.

Note This is only for first level documentation.

After configuring your documentation preferences, the extension will start downloading the documentation in background. (it might take some time, depending on the number of documentations to download). You will receive a notification when the index process finish.

You can then start searching Documentation from ulauncher using "docs" keyword.

Specific keywords.

Instead of using "docs" as keyword for everything, you can specify specific keywords for each programming language. You can configure them in manifest.json file.

Ex:

 {
      "id": "ruby",
      "type": "keyword",
      "name": "ruby",
      "default_value": "ruby~2.5"
},

Note The keyword id and name can be whatever you want, but the default value should match a existing language slug.

Configure how to open DevDocs

  • The default configuration will open the documentation on the default browser. You can change it to open in Hawkeye or with the custom DevDocs protocol. This will allow opening directly on DevDocs-desktop after this PR is merged.

Development

git clone https://github.com/brpaz/ulauncher-devdocs
make link

The make link command will symlink the cloned repo into the appropriate location on the ulauncher extensions folder.

To see your changes, stop ulauncher and run it from the command line with: ulauncher -v.

Contributing

Contributions, issues and Features requests are welcome.

Show your support

Buy Me A Coffee

License

Copywright @ 2019 Bruno Paz

This project is MIT Licensed.

You can’t perform that action at this time.