Package Exports

generator-playbook

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generator-playbook) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Playbook

Playbook is a Yeoman generator for Jekyll site utilizing thoughtbot's Bourbon, Neat and Bitters to allow for quick front end project spin up.

Grunt is used for compilation of Sass and CoffeeScript. Bower is used for managing dependencies.

Get Started

Prerequisites

If you do not have Node.js >=0.10, Ruby >=1.9, Yeoman >=1.1.2 and the Bundler gem installed, you must do that first:

Install Playbook

Playbook is installed like all other Yeoman generators: npm install -g generator-playbook

Usage

Create a Site

Playbook will run bundle install, so if you would like to install the Playbook gems into a gemset, set that up before running yo playbook.

cd path/to/desired/location/
mkdir project-name && cd project-name
yo playbook

Should you run into an error such as command yo not found it may be related to a path issue when installing Node.js via Homebrew. Please refer to the top answer on this StackOverflow question.

Grunt Tasks

Check, test & build for production: grunt
Serve the site locally: grunt serve
Deploy to production: grunt deploy
Check source: grunt check
Run tests: grunt test
Build for production: grunt build

Deployment

During the generation of your Playbook, you have the option of including grunt-build-control. You can use this tool to deploy to GitHub Pages or Heroku. You can deploy with the follow Grunt task:

grunt deploy