📦 techouse / alfred-vue-docs

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
34
35
36
37# Vue.js Docs Workflow for Alfred

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


Search the [Vue.js documentation](https://v3.vuejs.org/guide/introduction.html) using [Alfred](https://www.alfredapp.com/).

![demo](demo.gif)

## Installation

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

```
vue composition
```

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 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) using the _same_ index as the official [Vue.js](https://v3.vuejs.org/) website.