Skip to content

yannickglt/alfred-devdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 

Repository files navigation

alfred-devdocs Donate

Alfred workflow for the amazing devdocs.io documentations.

Install

Use the packaged workflow DevDocs.alfredworkflow from packal.

How to

Add a documentation

By default, the Alfred Devdocs workflow comes without any documentation. First of all, you must add one or several docs you want to browse using the cdoc:add command. For example:

cdoc:add javascript

Other configuration 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:all: Add all docs available to your workflow (not recommended)
  • cdoc:nuke: Remove all docs in your workflow
  • cdoc:refresh: Refresh cache for a doc (if specified) or all the added docs otherwise
  • cdoc:alias: Create an alias for a documentation
  • cdoc:unalias: Remove an existing alias of a documentation

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

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