๐Ÿ“ฆ techouse / alfred-flutter-docs

๐Ÿ“„ README.md ยท 33 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33# Flutter Docs Workflow for Alfred

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


Search the [Flutter documentation](https://api.flutter.dev/) using [Alfred](https://www.alfredapp.com/).

![demo](demo.gif)

## Installation

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

```
fl container
```

Either press `โŒ˜Y` to Quick Look the result, or press `<enter>` to open it in your web browser.

### 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 the whole [Flutter search index](https://api.flutter.dev/flutter/index.json).
A big thank you to [@algolia](https://github.com/algolia) and [@redox](https://github.com/redox) :heart: :heart: :heart: