This is a node-sass port of the Bourbon library. If you are looking for the original Ruby/Rails version, you can find it here.

Requirements

• node
• node-sass

Installation

To install as a development dependency, run:

npm install --save-dev node-bourbon

If you need it for production, replace --save-dev with --save.

Usage

The includePaths property returns an array of paths for use in node-sass' includePaths option.

var bourbon = require('node-bourbon').includePaths;

You can then use this array in your options:

var sass    = require('node-sass')
  , bourbon = require('node-bourbon').includePaths;

var paths = ['other/path', 'another/path'].concat(bourbon);

sass.render({
  file: './application.scss',
  success: function(css){
    console.log(css);
  },
  error: function(error) {
    console.log(error);
  },
  includePaths: paths,
  outputStyle: 'compressed'
});

Import Bourbon at the beginning of your main scss file. All additional stylesheets must be imported below Bourbon:

@import "bourbon";
@import "other/scss/partial";

Grunt Usage

Using the grunt-sass task:

grunt.initConfig({
  sass: {
    dist: {
      options: {
        includePaths: require('node-bourbon').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});

Using the grunt-contrib-sass task:

grunt.initConfig({
  sass: {
    dist: {
      options: {
        loadPath: require('node-bourbon').includePaths
      },
      files: {
        'path/to/output.css': 'path/to/input.scss'
      }
    }
  }
});

Testing

make test

Credits

This node-sass port is maintained by Michael LaCroix, however all credits for the Bourbon library go to thoughtbot, inc:

Bourbon is maintained and funded by thoughtbot, inc

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

Got questions? Need help? Tweet at @phillapier.

License

node-bourbon is Copyright © 2013 Michael LaCroix. It is free software, and may be redistributed under the terms specified in the LICENSE file.