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
- Host: GitHub
- URL: https://github.com/clayrisser/generator-jekyll-plugin
- Owner: clayrisser
- License: mit
- Created: 2018-02-24T15:32:31.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2023-12-06T04:49:54.000Z (over 1 year ago)
- Last Synced: 2025-05-07T11:17:38.283Z (about 2 months ago)
- Topics: generator, jekyll, jekyll-plugin, plugin, yeoman, yo, yoeman-generator
- Language: JavaScript
- Homepage: https://jam.jamrizzi.com
- Size: 1.1 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-jekyll-plugin
[](https://beerpay.io/jamrizzi/generator-jekyll-plugin)
[](https://beerpay.io/jamrizzi/generator-jekyll-plugin?focus=wish)
[](https://www.npmjs.com/package/generator-jekyll-plugin)
[](https://www.npmjs.com/package/generator-jekyll-plugin)
[](https://ci.jamrizzi.com/jamrizzi/generator-jekyll-plugin)
[](https://github.com/jamrizzi/generator-jekyll-plugin)
> 💎 Yeoman generator for jekyll plugins
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!
[](https://beerpay.io/jamrizzi/generator-jekyll-plugin)
[](https://beerpay.io/jamrizzi/generator-jekyll-plugin?focus=wish)