πŸ“¦ 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
Klemen TuΕ‘ar Klemen TuΕ‘ar :arrow_up: Add support for Django v4.1 bf9d591 3 years ago πŸ“ History
πŸ“‚ bf9d591f470a4e77efa00b2f9ead86393c26277e View all commits β†’
πŸ“ assets
πŸ“ bin
πŸ“„ .gitignore
πŸ“„ build.sh
πŸ“„ demo.gif
πŸ“„ info.plist
πŸ“„ LICENSE
πŸ“„ pubspec.lock
πŸ“„ pubspec.yaml
πŸ“„ README.md
πŸ“„ version
πŸ“„ README.md

Django Docs Workflow for Alfred

GitHub release GitHub All Releases GitHub

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 Branches

The workflow supports searching the documentation of all the currently officially supported branches. By default, it searches the latest stable branch. To search branch 3.2 or 2.2 simply type v3.2 or v2.2 anywhere in your query, like so:

dj v3.2 as_p

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.