https://github.com/cloudstek/alfred-hugo

Alfred workflow bindings for NodeJS
https://github.com/cloudstek/alfred-hugo

alfred alfred-workflow alfred-workflow-nodejs alfy nodejs script-filter

Last synced: 2 months ago
JSON representation

Alfred workflow bindings for NodeJS

• Host: GitHub
• URL: https://github.com/cloudstek/alfred-hugo
• Owner: Cloudstek
• License: bsd-2-clause
• Created: 2017-03-04T01:14:17.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T20:40:55.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T11:07:08.427Z (3 months ago)
• Topics: alfred, alfred-workflow, alfred-workflow-nodejs, alfy, nodejs, script-filter
• Language: TypeScript
• Size: 5.35 MB
• Stars: 19
• Watchers: 1
• Forks: 3
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# ![Hugo](https://cdn.rawgit.com/cloudstek/alfred-hugo/master/media/logo-hugo.svg)

[![CircleCI](https://img.shields.io/circleci/build/github/Cloudstek/alfred-hugo.svg)](https://circleci.com/gh/Cloudstek/alfred-hugo) [![Coverage Status](https://coveralls.io/repos/github/Cloudstek/alfred-hugo/badge.svg?branch=master)](https://coveralls.io/github/Cloudstek/alfred-hugo?branch=master) [![Open Issues](https://img.shields.io/github/issues/Cloudstek/alfred-hugo.svg)](https://github.com/Cloudstek/alfred-hugo/issues) ![npm](https://img.shields.io/npm/dt/alfred-hugo.svg) ![GitHub](https://img.shields.io/github/license/Cloudstek/alfred-hugo.svg) ![GitHub stars](https://img.shields.io/github/stars/Cloudstek/alfred-hugo.svg)

Hugo is a [script filter](https://www.alfredapp.com/help/workflows/inputs/script-filter/) framework for your Alfred workflows. It can handle fetching and caching data, configuration storage, checking for updates and much much more. But I suppose you can use it for other purposes in your workflow as well :man_shrugging:

### Highlights

* Written in Typescript :star:

* Well tested :thumbsup:

* Built-in cache and configuration storage

* Advanced filtering of items using [Fuse.js](http://fusejs.io) :mag:

* Fetch (JSON) from REST API's using [Axios](https://github.com/axios/axios) :earth_americas:

* Update notifications :mailbox:

## Getting started

### Prerequisites

* NodeJS 10 or higher

* Alfred 4 with [paid powerpack addon](https://www.alfredapp.com/powerpack/buy/)

### Installing

Hugo can be installed using Yarn or NPM:

```bash

$ yarn add alfred-hugo

```

```bash

$ npm install --save alfred-hugo

```

### Writing your script filter

Please see the [docs](./docs) for documentation and examples on how to use Hugo to write your script filters.

### Publishing your workflow to NPM

To publish your workflow to NPM, set up the `postinstall` and `preuninstall` scripts in your `package.json` as follows to automatically add your workflow to Alfred.

```json

{

  "name": "alfred-unicorn",

  "scripts": {

    "postinstall": "hugo-link",

    "preuninstall": "hugo-unlink"

  }

}

```

People can now install your package globally like this:

```bash

$ npm install -g my-alfred-package

```

## Workflows using Hugo

List of Alfred workflows using Hugo. 

* [alfred-atom](https://github.com/Cloudstek/alfred-atom) - Alfred workflow to browse and open Atom projects

*Feel free to submit your own by opening an [issue](https://github.com/Cloudstek/alfred-hugo/issues) or submitting a [pull request](https://github.com/Cloudstek/alfred-hugo/pulls).*

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for more info about how to contribute.

## Authors

* [Maarten de Boer](https://github.com/mdeboer)

### Contributors 

* [Marjolein Regterschot](https://github.com/rmarjolein) (Artwork)

## License

BSD-2-Clause license, see [LICENSE](LICENSE).