Playbook

Jump start your interface development.

Currently

Playbook is a Yeoman generator to get you building interfaces faster. Jekyll is included for static site generation. Bourbon, Neat & Bitters are included to help you write CSS faster.

Prerequisites

Playbook requires Yeoman, Ruby & Bundler. If you are unfamiliar with Yeoman generators, we recommend familiarizing yourself first.

Installation

npm install -g generator-playbook

Usage

mkdir project-directory && cd project-directory
yo playbook

Grunt Tasks

grunt serve

Serve your source locally into your browser. LiveReload will automatically load any changes to HTML, CSS and JavaScript that you make.

grunt check

Check the quality of your source with tools like JSLint, CSSLint and csscss.

grunt test

Run any test that you have defined for your source.

grunt build

Build the concatenated, minified production version of the source into the dist directory.

grunt deploy

Deploy the production version of the source to GitHub Pages via grunt-build-control. This ability is configurable during Playbook generation.