An open API service indexing awesome lists of open source software.

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

Search the Vue.js v3 and v2 documentation using Alfred.
https://github.com/techouse/alfred-vue-docs

alfred-workflow algolia-search vuejs vuejs3

Last synced: about 1 year ago
JSON representation

Search the Vue.js v3 and v2 documentation using Alfred.

Awesome Lists containing this project

README

          

# 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 `` 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.