Giter Club home page Giter Club logo

alfred-django-docs's Introduction

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.

alfred-django-docs's People

Contributors

dependabot[bot] avatar techouse avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

alfred-django-docs's Issues

Hello from Algolia ๐Ÿ‘‹

Hello,

really cool to see this Alfred workflow, awesome initiative :)

I was reading your README and stumbled upon

Built using Alfred-Workflow. The search is powered by Algolia search using a free Community plan. Since the community plan only supports 10,000 records I had to cut it short and support only 2 branches of the documentation. That is the reason why there is no documentation for the 2.0 branch.

Which of course made me sad :) So I've just upgraded your FREE plan to 50k records and 500k operations. Enjoy ;)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.