๐Ÿ“ฆ techouse / alfred-django-docs

Search the Django documentation using Alfred and Algolia

โ˜… 6 stars โ‘‚ 0 forks ๐Ÿ‘ 6 watching โš–๏ธ MIT License
alfred-workflowalgolia-searchdjangodocumentationpython
๐Ÿ“ฅ Clone https://github.com/techouse/alfred-django-docs.git
HTTPS git clone https://github.com/techouse/alfred-django-docs.git
SSH git clone git@github.com:techouse/alfred-django-docs.git
CLI gh repo clone techouse/alfred-django-docs
dependabot[bot] dependabot[bot] :arrow_up: Bump actions/checkout from 5 to 6 (#73) e6143f8 1 months ago ๐Ÿ“ History
๐Ÿ“‚ master View all commits โ†’
๐Ÿ“ .github
๐Ÿ“ assets
๐Ÿ“ bin
๐Ÿ“„ .env.example
๐Ÿ“„ .gitignore
๐Ÿ“„ build.sh
๐Ÿ“„ configure.png
๐Ÿ“„ demo.gif
๐Ÿ“„ entitlements.plist
๐Ÿ“„ info.plist
๐Ÿ“„ LICENSE
๐Ÿ“„ Makefile
๐Ÿ“„ pubspec.lock
๐Ÿ“„ pubspec.yaml
๐Ÿ“„ README.md
๐Ÿ“„ README.md

Django Docs Workflow for Alfred

GitHub release GitHub All Releases GitHub GitHub Sponsors

Search the Django documentation using Alfred.

demo

Installation

  • Download the latest version
  • Install the workflow by double-clicking the .alfredworkflow file
  • 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 :innocent: :beers: :heart:

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