https://github.com/nicklayb/alfred-elm
Alfred workflow for browsing Elm's packages documentation
https://github.com/nicklayb/alfred-elm
Last synced: about 1 year ago
JSON representation
Alfred workflow for browsing Elm's packages documentation
- Host: GitHub
- URL: https://github.com/nicklayb/alfred-elm
- Owner: nicklayb
- License: mit
- Created: 2019-11-01T02:15:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-11T15:54:24.000Z (almost 5 years ago)
- Last Synced: 2024-09-25T09:26:24.103Z (almost 2 years ago)
- Language: JavaScript
- Size: 1.64 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# alfred-elm
> Alfred workflow to browse Elm's documentation
## Install
```
$ npm i -g alfred-elm
```
*Requires [Node.js](https://nodejs.org) 4+ and the Alfred [Powerpack](https://www.alfredapp.com/powerpack/).*
## Usage
### `elmc`
Same as `elm` but with `elm/core` package pre-selected
### `elm`
Browse Elm packages, find a package by typing the name.
If you recently browse packages, these are shown by default instead of all the packages
- On **Enter** press: Browse the selected package modules
- On **Cmd+Enter** press: Open package documentation page URL
### Browsing modules
- On **Enter** press: Browse selected module functions
- On **Cmd+Enter** press: Open module documentation page URL
### Browsing functions
- On **Enter** press: Open function documentation page URL
## Recents
By default, everytime you lookup a package, these are cached so you can quickly come back later on by simply typing `elm`. You can clear this cache by running `elmr`.
## License
MIT © [Nicolas Boisvert](http://nboisvert.com)