Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 2.26 KB

README.md

File metadata and controls

54 lines (35 loc) · 2.26 KB
Raw

Roots child theme generator Build Status

Version: 0.1.4

A Yeoman generator for scaffolding a custom Roots child theme.

Contributors

Duane Cilliers ( @duanecilliers / signpost.co.za / duane.co.za )

Summary

A Roots child theme generator for WordPress. Choose between Sass Bootstrap, LESS Bootstrap or CSS bootstrap, optionally include Modernizr with leaner builds and Grunt for all tasks.

Features

  • All the benefits of Roots
  • Choose between Sass Bootstrap, LESS Bootsrap or no CSS pre-processor (enqueues minified Bootstrap).
  • LiveReload the browser (with extension)
  • CSS Autoprefixing
  • Automatically compile Compass/Sass/Less
  • Automatically lint, concatenate and minify your JavaScript (with source maps)
  • Automatically version your styles and scripts with an md5 hash
  • Awesome Image Optimization (via OptiPNG, pngquant, jpegtran and gifsicle)
  • Optional - Leaner Modernizr builds
  • Deploy your theme via Rsync

Usage

  • Make sure you have yo installed: npm install -g yo
  • Install the generator: npm install -g generator-roots-child
  • Run yo roots-child inside an empty theme directory.
  • Run grunt for building and grunt dev for watching and compiling
  • Make sure you have Roots (the parent theme) installed

Bower

Supports bower to install and manage dependencies in the bower_components folder.

FAQs

  • Why are no styles reflecting?
    • If the 'WP_DEV_MODE' constant is set to true, be sure to run $ grunt dev to watch and compile changes. If 'WP_DEV_MODE' is not set or is false, minified assets are enqueued, so be sure to run $ grunt which compiles and minfies CSS and JavaScript. While developing, I suggest adding define( 'WP_DEV_MODE', true ) to wp-config.php.

TODOs

  • Consider deployment config prompts
  • Code a test script with mocha

License

MIT License