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

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

alfred-workflow algolia-search documentation flask python

Last synced: 8 months ago
JSON representation

Search the Flask documentation using Alfred and Algolia

• Host: GitHub
• URL: https://github.com/techouse/alfred-flask-docs
• Owner: techouse
• License: mit
• Created: 2018-11-06T22:46:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-08-12T20:21:25.000Z (almost 2 years ago)
• Last Synced: 2024-10-19T14:21:05.025Z (over 1 year ago)
• Topics: alfred-workflow, algolia-search, documentation, flask, python
• Language: Dart
• Size: 4.46 MB
• Stars: 2
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Flask Docs Workflow for Alfred

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

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

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

Search the [Flask documentation](http://flask.pocoo.org/docs/1.0/) using [Alfred](https://www.alfredapp.com/). 

![demo](demo.gif)

## Installation

1. [Download the latest version](https://github.com/techouse/alfred-flask-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 `flask` followed by your search query.

```

flask jsonify

```

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

## Changing Branches

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 for all these Alfred Workflows.

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 Flask Sphinx HTML documentation using a [simple Python script](https://github.com/techouse/flask-docs-parser) I wrote.