generator-jekyll-yeti

Yeoman generator

Getting Started

Dependencies

NodeJs tested v0.10.38

Ruby tested v2.1.4

Jekyll tested v2.5.3

Foundation

Tested with latest version 5.5.2

Install Yo

npm install -g yo

Install Jekyll-Yeti

To install generator-jekyll-yeti from npm, run:

npm install -g generator-jekyll-yeti

Finally, change into your project directory and initiate the generator :

yo jekyll-yeti

Screen

Notes

Components

Jekyll & Yeti uses modular Foundation components, allowing you to remove unnecessary css and js for an even quicker page load. The remaining sccs is compiled, the css and js is then compressed and concatenated in the final Grunt build.

Scss:

All Foundation Scss components are in the main scss file: jekyll/css/main.scss. Comment out or delete uneeded components here.

Foundation settings can be overridden here: jekyll/_scss/_settings.scss.

Javascript:

Foundation scripts are loaded one by one in jekyll/_includes/footer.html. Remove unused scripts here, the remaining scripts will be concatenated and uglified into a single foundation script.

Deploy

Manual:

Simply upload the contents of the dist/ folder to your webserver

Github Pages:

You can init your repo in the dist/ folder. Subsequent grunt tasks will ignore the .git subfolder, keeping version control

Rsync:

TODO

Grunt

Start Jekyll server (Grunt Shell): grunt

Build Jekyll site into _site without running server: grunt build

Install library via bower: bower install <lib> --save

Use Wiredep to inject dependency JS and CSS into html: grunt bower

Build final optimized site (from jekyll/_site) into the /dist folder: grunt dist

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

Credit

A lot of the Foundation parts of this generator are inspired by Julian Cwirko's great ZF5 generator, my goto for starting quick Foundation projects.

License

MIT