Skip to content

techouse/alfred-flask-docs

Repository files navigation

Flask Docs Workflow for Alfred

GitHub release GitHub All Releases GitHub

Search the Flask documentation using Alfred.

demo

Installation

  1. Download the latest version
  2. Install the workflow by double-clicking the .alfredworkflow file
  3. You can add the workflow to a category, then click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.

Usage

Just type flask followed by your search query.

flask jsonify

Either press ⌘Y to Quick Look the result, or press <enter> to open it in your web browser.

Changing Branches

The workflow supports searching the documentation of several versions. To change the branch, configure the Workflow as show in the image below.

configure

Note

The lightning fast search is powered by Algolia which was generous enough to hand me a big enough plan for all these Alfred Workflows. A big thank you to @redox from @algolia 😇 🍻 ❤️

The index for Algolia was compiled from the Flask Sphinx HTML documentation using a simple Python script I wrote.