Home

Awesome

Build Status

Bespoke.js Theme Generator

A generator for Yeoman that scaffolds a Bespoke.js theme.

The boilerplate plugin includes a Gulp build system with Browserify, Stylus, Normalize.css and Autoprefixer preconfigured.

Usage

Assuming you have Node.js, install generator-bespoketheme:

$ npm install -g generator-bespoketheme

Make a new directory and cd into it:

$ mkdir bespoke-theme-mytheme
$ cd bespoke-theme-mytheme

Scaffold a new presentation:

$ yo bespoketheme

Theme workflow

All source files for the theme reside in the lib directory.

Distributable versions of your theme are generated in the dist directory by the following gulp tasks:

Gulp tasks

Compile the project:

$ gulp

Recompile your theme whenever source files change:

$ gulp dev

View the demo in a browser with LiveReload:

$ gulp demo

Compile and deploy the demo to GitHub pages:

$ gulp deploy

Publish to npm

$ npm publish

Register with Bower

Register theme with Bower:

$ bower register <my-theme-name> <git-endpoint>

Bower uses Git tags for versioning.

To publish an update, first modify the version number in bower.json, then tag a new version and push to origin:

$ git add .
$ git commit -m "Bump to vX.X.X"
$ git tag -a vX.X.X -m "vX.X.X"
$ git push --tags origin master

License

MIT License