/alfred-django-docs

Search the Django documentation using Alfred and Algolia

Primary LanguageDartMIT LicenseMIT

Django Docs Workflow for Alfred

GitHub release GitHub All Releases GitHub GitHub Sponsors

Search the Django 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 dj followed by your search query.

dj FormView

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

Changing the Django version to search

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 to fit all the indices for the officially supported Django documentation versions. A big thank you to @redox from @algolia 😇 🍻 ❤️

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