A Yeoman generator for prototyping and building experiences.


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

Gulp is used for compilation of Sass and CoffeeScript (optional). Bower is used for managing dependencies.

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

npm install -g generator-playbook

If you already have generator-playbook installed, please upgrade before generating another site to get the latest updates.

npm list -g | grep 'generator-playbook' # See your installed version
npm info generator-playbook | grep 'latest' # See latest generator-playbook version
npm update -g generator-playbook # Upgrade generator-playbook globally

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.

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.

Serve your source locally into your browser. BrowserSync automatically loads any changes to HTML, CSS and JavaScript that you make.

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

Deploy the production build of your source to GitHub Pages.

If you choose to deploy a GitHub User/Organization Page, your source must be tracked in a branch other than master. User/Organization Pages serve the master branch to users visiting your Page. For more information, please see the GitHub Pages Help.