Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommasongr/generator-jekyll-rocks
Jekyll Rocks –– Yeoman generator to boost your Jekyll workflow with Grunt, livereload, sass, uglify, postcss, git, ftp and your favourite front end framework!
https://github.com/tommasongr/generator-jekyll-rocks
framework ftp generator git grunt jekyll livereload sass scaffold yeoman-generator
Last synced: about 2 months ago
JSON representation
Jekyll Rocks –– Yeoman generator to boost your Jekyll workflow with Grunt, livereload, sass, uglify, postcss, git, ftp and your favourite front end framework!
- Host: GitHub
- URL: https://github.com/tommasongr/generator-jekyll-rocks
- Owner: tommasongr
- License: mit
- Created: 2018-02-08T21:24:19.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-01-16T22:52:47.000Z (about 6 years ago)
- Last Synced: 2024-12-03T15:49:32.850Z (about 2 months ago)
- Topics: framework, ftp, generator, git, grunt, jekyll, livereload, sass, scaffold, yeoman-generator
- Language: CSS
- Homepage:
- Size: 324 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Generator Jekyll Rocks
[](https://www.npmjs.com/package/generator-jekyll-rocks) [](https://github.com/tommaso-negri/generator-jekyll-rocks/) [](https://github.com/tommaso-negri/generator-jekyll-rocks/) [](https://github.com/tommaso-negri/generator-jekyll-rocks/issues) [](https://www.npmjs.com/package/generator-jekyll-rocks)
**Boost your Jekyll workflow with Grunt!**
Jekyll Rocks Generator uses the [Yeoman](http://yeoman.io) technology to scaffold a basic [Jekyll](http://jekyllrb.com/) environment that in union with [Grunt](https://gruntjs.com) makes the perfect development workflow.
The Generator comes with cool featuresas livereload, sass, uglify, postcss and Git or FTP deploy. You could choose also to use a front end framework. At this time are available [Bootstrap 4](http://getbootstrap.com), [Foundation 6](https://foundation.zurb.com), [Semantic UI](https://semantic-ui.com), [Material Design Lite](https://getmdl.io) or [Materialize](http://materializecss.com). But you can obviously install whatever you want in a second time.
## Features
**During setup you can choose:**
- [Sass](http://sass-lang.com/), Scss or vanilla CSS
- A framework between: [Bootstrap 4](http://getbootstrap.com), [Foundation 6](https://foundation.zurb.com), [Semantic UI](https://semantic-ui.com), [Material Design Lite](https://getmdl.io) or [Materialize](http://materializecss.com)
- Automatic push of your code on branch master
- Automatic deploy of your site on gh-pages, ftp or both
**Jekyll-Rocks always includes:**
- Automatic Jekyll and preprocessor compiling
- An automatic build process that includes concatenation, image and svg optimization, CSS minification and JS uglification
## Prerequisites
To install this project, you'll need the following things installed on your machine.
1. [RubyGems](https://rubygems.org/pages/download) - follow the guide.
2. [Jekyll](http://jekyllrb.com/) - `$ gem install jekyll bundler`
3. [NodeJS](http://nodejs.org) - use the installer.
## Getting Started
First, install [Grunt](https://gruntjs.com) and [Bower](https://bower.io) using [npm](https://www.npmjs.com/).
```shell
$ npm install -g grunt-cli
$ npm install -g bower
```
Second, install [Yeoman](http://yeoman.io) and generator-jekyll-rocks.
```shell
$ npm install -g yo
$ npm install -g generator-jekyll-rocks
```
Then generate your new project:
```shell
$ yo jekyll-rocks
```
## Grunt Workflow
**Development mode**
This will give you jekyll server, file watching, uglify, postcss, auto-rebuild etc.
You have to work only with app/ dir files.
You will find common jekyll server builded files under .jekyll/
```shell
$ grunt serve
```
**Build mode**
This will build your jekyll site minimizing all your sass, css, js, img and svg.
You could find the builded site under dist/
```shell
$ grunt build
```
**Clear mode**
This will clear all your tmp files, sass-cache etc.
```shell
$ grunt clear
```
**Push mode**
You can easily push your files on your branch master.
NOTICE: this command is available only if in the setup you choose it
```shell
$ grunt push
```
**Push mode**
You can easily deploy your site on your branch gh-pages, your ftp or both.
NOTICE: this command is available only if in the setup you at least one of these options.
```shell
$ grunt deploy
```
## Getting To Know Yeoman
* Yeoman has a heart of gold.
* Yeoman is a person with feelings and opinions, but is very easy to work with.
* Yeoman can be too opinionated at times but is easily convinced not to be.
* Feel free to [learn more about Yeoman](http://yeoman.io/).
## License
MIT © [Tommaso Negri](https://github.com/tommaso-negri)