grunt-wellington v0.4.0

grunt-wellington

Compile Sass and sprite images with Wellington

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

Installation

This plugin requires the following as peer dependencies:

• grunt >= 0.4.0
• wellington-bin >= 1.0.0

npm install wellington-bin --save-dev
npm install grunt-wellington --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-wellington');

Wellington Task

Run this task with the grunt wellington command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

For more explanations of the options available please visit the Wellington website..

Options

All of these options are taken from the list of available commands in the Wellington project.

b

Type: String

Path to target directory to place generated CSS, relative paths inside project directory are preserved

comment

Type: Boolean

Turn on source comments

c

Type: String

Temporarily disabled: Location of the config file

debug

Type: Boolean

Show detailed debug information

d

Type: String

Path to locate images for spriting and image functions

font

Type: String

Path to directory containing fonts

gen

Type: String

Path to place generated images

no-line-comments

Type: Boolean

UNSUPPORTED: Disable line comments

p

Type: String

Path to directory containing Sass stylesheets

relative-assets

Type: Boolean

UNSUPPORTED: Make compass asset helpers generate relative urls to assets.

s

Type: String

nested style of output CSS available options: nested, expanded, compact, compressed

time

Type: Boolean

Retrieve timing information

Usage Examples

Basic configuration

wellington: {
	your_target: {
		src: [
			'sass/**/*.scss'
		],
		options: {
			p: 'sass',
			b: 'build/css',
			d: 'img/sass',
			font: 'font-face',
			gen: 'build/img'
		}
	}
}