README.md

Project made using Liquid, a Yeoman generator for building WordPress and static projects with the following: Scotch Box (Vagrant), Gulp, SCSS, BrowserSync.

Table of contents

• Commands
  • Vagrant
  • Dependencies
  • Gulp
  • CSScomb

Commands

Vagrant

There's a config.php file embedded in the Liquid theme that displays the Vagrant configuration settings for the project. Once Vagrant is running, you can access the file, locally, at http://192.168.33.10/config.php.

Start/Resume server

$ vagrant up

Pause server

$ vagrant suspend

Stop server

$ vagrant halt

Reload server

$ vagrant reload

Destroy server

$ vagrant destroy

Dependencies

The package.json file has been set up to trigger the bower-installer tool after npm install is complete. This will automagically run bower install. In the case that you need to install bower components manually, the command is below.

Install node modules

$ npm install

Install bower components

$ bower install

Gulp

Default task

Builds source code to the theme folder, launches BrowserSync, and watches for code changes.

$ gulp

Build task

Builds source code to the theme folder.

$ gulp build

CSScomb

CSScomb is a coding style formatter that uses the .csscomb.json configuration file in the project root to format CSS.

Install CSScomb

npm install -g csscomb

Use CSScomb

csscomb src/assets/scss/

CSScomb plugins

• Atom
• Sublime Text