Alfred workflow for devdocs.io
Clone or download

README.md

alfred-devdocs

Alfred workflow for the amazing devdocs.io documentations.

Install

Use the packaged workflow DevDocs.alfredworkflow from packal.

How to

Find in a specific documentation

Keywords exist for each documentation supported by DevDocs.

AngularJS documentation

Completion

Filter on functions

Global search

Global search may be slow the first time it is called because it will download all the documentations at once.

Global search

Alfred preview

Using the "shift" key on a function will display a preview (using quicklook) of the doc. Preview

How to configure this workflow

By default, all docs are present in this workflow but maybe you dont need all docs and just a few of them. We have added a way to configure it with cdocs:... commands

Availables commands

  • cdoc:list = List all docs you can add in your workflow
  • cdoc:add = Add a doc in your workflow, if you have already all docs, that command do nothing
  • cdoc:remove = Remove a doc in your workflow, if you haven't a doc in your workflow, that command do nothing
  • cdoc:addall = Add all docs available to your workflow
  • cdoc:nuke = Remove all docs in your workflow
  • cdoc:refresh = Refresh cache for a doc if specified or all if you want.
  • cdoc:alias = Create an alias for a documentation
  • cdoc:unalias = Remove an existing alias of a documentation

Use behind an HTTP proxy

Define the HTTP_PROXY environment variable in Alfred as below. You can define the HTTP_PROXY_AUTHORIZATION as well if your proxy needs basic authentication. image