Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/clayrisser/generator-jekyll-plugin

💎 Yeoman generator for jekyll plugins
https://github.com/clayrisser/generator-jekyll-plugin

generator jekyll jekyll-plugin plugin yeoman yo yoeman-generator

Last synced: about 2 months ago
JSON representation

💎 Yeoman generator for jekyll plugins

Awesome Lists containing this project

README

        

# generator-jekyll-plugin

[![Beerpay](https://beerpay.io/jamrizzi/generator-jekyll-plugin/badge.svg?style=beer-square)](https://beerpay.io/jamrizzi/generator-jekyll-plugin)
[![Beerpay](https://beerpay.io/jamrizzi/generator-jekyll-plugin/make-wish.svg?style=flat-square)](https://beerpay.io/jamrizzi/generator-jekyll-plugin?focus=wish)
[![NPM](https://img.shields.io/npm/v/generator-jekyll-plugin.svg?style=flat-square)](https://www.npmjs.com/package/generator-jekyll-plugin)
[![NPM](https://img.shields.io/npm/dt/generator-jekyll-plugin.svg?style=flat-square)](https://www.npmjs.com/package/generator-jekyll-plugin)
[![Drone](https://ci.jamrizzi.com/api/badges/jamrizzi/generator-jekyll-plugin/status.svg)](https://ci.jamrizzi.com/jamrizzi/generator-jekyll-plugin)
[![GitHub stars](https://img.shields.io/github/stars/jamrizzi/generator-jekyll-plugin.svg?style=social&label=Stars)](https://github.com/jamrizzi/generator-jekyll-plugin)

> 💎 Yeoman generator for jekyll plugins

![](assets/generator-jekyll-plugin.png)

Please ★ this repo if you found it useful ★ ★ ★

## Features

* Live development environment
* Jekyll best practices
* Publish as gem

## Installation

```sh
sudo npm install -g yo generator-jekyll-plugin
```

## Dependencies

* [NodeJS](https://nodejs.org)
* [GNU Make](https://www.gnu.org/software/make)
* [Ruby](https://www.ruby-lang.org)
* [Bundler](http://bundler.io)

## Usage

```sh
yo jekyll-plugin
```

### Makefile

| **Command** | **Description** |
| ----------- | --------------------------------------------------------- |
| `make start` | Start Jekyll plugin development server |
| `make build` | Build Jekyll plugin gem |
| `make install` | Install dependancies for Jekyll plugin development server |
| `make push` | Publish Jekyll plugin to rubygems |
| `make clean` | Clean build and development files |
| `make deps` | Install development tools |

## Support

Submit an [issue](https://github.com/jamrizzi/generator-jekyll-plugin/issues/new)

## Contributing

Review the [guidelines for contributing](https://github.com/jamrizzi/generator-jekyll-plugin/blob/master/CONTRIBUTING.md)

## License

[MIT License](https://github.com/jamrizzi/generator-jekyll-plugin/blob/master/LICENSE)

[Jam Risser](https://jam.jamrizzi.com) © 2018

## Changelog

Review the [changelog](https://github.com/jamrizzi/generator-jekyll-plugin/blob/master/CHANGELOG.md)

## Credits

* [Jam Risser](https://jam.jamrizzi.com) - Author

## Support on Beerpay (actually, I drink coffee)

A ridiculous amount of coffee :coffee: :coffee: :coffee: was consumed in the process of building this project.

[Add some fuel](https://beerpay.io/jamrizzi/generator-jekyll-plugin) if you'd like to keep me going!

[![Beerpay](https://beerpay.io/jamrizzi/generator-jekyll-plugin/badge.svg?style=beer-square)](https://beerpay.io/jamrizzi/generator-jekyll-plugin)
[![Beerpay](https://beerpay.io/jamrizzi/generator-jekyll-plugin/make-wish.svg?style=flat-square)](https://beerpay.io/jamrizzi/generator-jekyll-plugin?focus=wish)