Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/techouse/alfred-react-docs
Search the React documentation using Alfred
https://github.com/techouse/alfred-react-docs
alfred-workflow algolia-search documentation react
Last synced: 3 days ago
JSON representation
Search the React documentation using Alfred
- Host: GitHub
- URL: https://github.com/techouse/alfred-react-docs
- Owner: techouse
- License: mit
- Created: 2019-09-16T09:48:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-13T13:38:48.000Z (3 months ago)
- Last Synced: 2024-07-13T14:50:59.402Z (3 months ago)
- Topics: alfred-workflow, algolia-search, documentation, react
- Language: Dart
- Size: 3.22 MB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# React Docs Workflow for Alfred
![GitHub release](https://img.shields.io/github/release/techouse/alfred-react-docs.svg)
![GitHub All Releases](https://img.shields.io/github/downloads/techouse/alfred-react-docs/total.svg)
![GitHub](https://img.shields.io/github/license/techouse/alfred-react-docs.svg)Search the [React documentation](https://reactjs.org/docs/getting-started.html) using [Alfred](https://www.alfredapp.com/).
![demo](demo.gif)
## Installation
1. [Download the latest version](https://github.com/techouse/alfred-react-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 `rjs` followed by your search query.
```
rjs state
```Either press `⌘Y` to Quick Look the result, or press `` to open it in your web browser.
### Note
The lightning fast search is powered by [Algolia](https://www.algolia.com) using the _same_ index as the official [React](https://react.dev/learn) website.