https://github.com/techouse/alfred-django-docs

Search the Django documentation using Alfred and Algolia
https://github.com/techouse/alfred-django-docs

alfred-workflow algolia-search django documentation python

Last synced: 3 days ago
JSON representation

Search the Django documentation using Alfred and Algolia

• Host: GitHub
• URL: https://github.com/techouse/alfred-django-docs
• Owner: techouse
• License: mit
• Created: 2018-11-03T15:54:26.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-13T13:47:23.000Z (3 months ago)
• Last Synced: 2024-07-13T15:00:34.258Z (3 months ago)
• Topics: alfred-workflow, algolia-search, django, documentation, python
• Language: Dart
• Homepage:
• Size: 11.8 MB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django Docs Workflow for Alfred

![GitHub release](https://img.shields.io/github/release/techouse/alfred-django-docs.svg)

![GitHub All Releases](https://img.shields.io/github/downloads/techouse/alfred-django-docs/total.svg)

![GitHub](https://img.shields.io/github/license/techouse/alfred-django-docs.svg)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/techouse)](https://github.com/sponsors/techouse)

Search the [Django documentation](https://docs.djangoproject.com/) using [Alfred](https://www.alfredapp.com/). 

![demo](demo.gif)

## Installation

1. [Download the latest version](https://github.com/techouse/alfred-django-docs/releases/latest)

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 `` 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](configure.png)

### Note

The lightning fast search is powered by [Algolia](https://www.algolia.com) 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](https://github.com/redox) from [@algolia](https://github.com/algolia) :innocent: :beers: :heart:

The index for Algolia was compiled from the zipped Django HTML documentation using a [simple Python script](https://github.com/techouse/django-docs-parser) I wrote.