Skip to content

paulovida/happyplan

 
 

Repository files navigation

HappyPlan!

Build Status

When Grunt.js uses Jekyll as a peon.

HappyPlan is a static website generator based on a bundle of amazing tools. It's just all about fun.

What in it?

  • A static website generator from html or markdown: Jekyll.
  • A task-based command line build tool: Grunt.js & all pre-defined tasks you'll need (scripts, styles & images automatic minification & compression).
  • An amazing CSS pre-processor, Sass directly served with Compass.
  • A quick way to provide scalable icons as font thanks an awesome Grunt task grunt-webfont.
  • A Livereload server provided by the grunt-contrib-watch task) to make development as fast as hell.
  • Support the Bower package manager to handle web components.

Oh, by the way, why "happy plan" ? Here is not the answer.

Documentation

Visit the wiki for all the things.

TL;DR

According you already have Ruby and NPM installed you can run this commands :

gem install jekyll compass
npm install -g grunt-cli bower happyplan-cli
npm init
npm install happyplan --save-dev
happyplan --help

Learn more about requirements.

Contributing

When you want to fix a bug or add a feature, just be sure to get all testing requirements installed, & run tests before making your Pull Request.

You can run in one command the build process & the tests.

$ npm test

In case you don't know it yet, npm {cmd} just run the command {cmd} specified in the package.json script section. In our case, it run grunt test. And to be precise, the test task run the nodeunit one.

Release History

Checkout CHANGELOG

Support

IRC

Come up and say hello on IRC! We'll be glad to answer you if you have any questions.

#happyplan on irc.freenode.net

Twitter

Follow us on Twitter to get latest news: @happyplanapp

Credits

Thank you Catherine Please for your excellent logo.

Authors

About

A static file generator using jekyll, compass, fontcustom and grunt.

Resources

License

Stars

Watchers

Forks

Packages

No packages published