United World Wrestling Styleguide

This is a Yeoman generated styleguide for unitedworldwrestling.

Website: http://unitedworldwrestling.org Staging: http://staging.unitedworldwrestling.org Repo: https://bitbucket.org/fila-wrestling/unitedworldwrestling-drupal7

This styleguide is published to Bower and needs to be installed on the main project as a dependency. This way we can update it easily through here.

Installation

To setup your work environment, make sure you first have NodeJS and the Hologram gem installed globally.

# Install bower globally
$ npm install -g bower

# Install all npm dependencies
$ npm install

# Install all bower dependencies
$ bower install

How to build the styleguide

This styleguide use Hologram as Ruby dependencies to generate a styleguide. First step is to install Hologram v1.3.1 as global dependencies.

$ gem install hologram --version 1.3.1

(All tasks are available on their own, just type $ gulp -T to list them all.)

The default $ gulp command will clean all previously built folders, compile all .scss files, compile all .js files, concatenate all .js files, lint .js files, build the hologram styleguide.

$ gulp

How to watch and compile files as you go

The $ gulp serve task will launch a Browser-Sync server and watch all changes in .scss files as you go.

$ gulp serve

How to publish to GH Pages

Just use this to publish the styleguide to the gh-pages.

$ gulp deploy