generator-sparkywp

Yeoman generator for SparkyWP, a clean, GulpJS-ready starter kit.

Usage no npm install needed!

<script type="module">
  import generatorSparkywp from 'https://cdn.skypack.dev/generator-sparkywp';
</script>

README

Generate SparkyWP

This is a Yeoman generator that let you quickly and easily create a new WordPress theme/plugin based on SparkyWP, a starter theme/plugin. The generated starter theme is ready to roll with naming conventions based on your generator input, and with Sass and Gulp.js for further automation as you work on your customizations.

Getting Started

Install Yeoman

If you don't already have Yeoman installed, you'll need to take care of that:

$ npm install -g yo

Or, if you get errors related to permissions, try:

$ sudo npm install -g yo

Install SparkyWP Yeoman

You can install the SparkyWP generator using the command:

$ npm install -g generator-sparkywp

Then, you should be able to initiate the generator.

$ yo sparkywp

You'll want to do this from your /wp-content/themes or /wp-content/plugins directory or wherever you want your new theme folder to live. Your theme/plugin files will be created in their own directory, named based on your input.

That's all there is to it!

Changelog

Version 2.1.0 - TBD

  • Feature - Added a sparky- prefix to the theme (child themes).
  • Feature - Automatically downloads the main theme + child theme for Sparky.

Version 2.0.0 - 4/12/2015

  • Fix - Fixed some NPM errors.
  • Fix - Removed the "bower install" + "gulp build", too many issues.
  • Feature - Add a plugin package to the generator.
  • Feature - Execute "npm install" commands.
  • Feature - Prompt Questions.
  • Feature - Add a theme package to the generator.

Version 1.0.0 - 4/11/2015

  • Feature - Initial release