Skip to content
This repository
file 101 lines (59 sloc) 3.872 kb

Bourbon Sass Mixin Library

Gem Version Code Climate Gitter chat

A lightweight mixin library for Sass

Bourbon is a library of pure sass mixins that are designed to be simple and easy to use. No configuration required.

The mixins aim to be as vanilla as possible, meaning they should be as close to the original CSS syntax as possible.

The mixins contain vendor specific prefixes for all CSS3 properties for support amongst modern browsers. The prefixes also ensure graceful degradation for older browsers that support only CSS3 prefixed properties. Bourbon uses SCSS syntax.

Documentation & Demo

Requirements

Sass 3.2+

Install for Rails 3.1+

In your Gemfile:

gem 'bourbon'

Then run:

$ bundle install

Restart your server. Then rename application.css to application.css.scss:

mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss

Delete the sprocket directive in application.css.scss: Why?

*= require_tree .

Import Bourbon at the beginning of application.css.scss. All additional stylesheets must be imported below Bourbon:

@import "bourbon";
@import "home";
@import "users";

Help! I'm getting an undefined mixin error.

Rails 3.0.x Install Instructions | Rails 2.3 Install Instructions

Non-Rails projects

Bourbon includes an easy way to generate a directory with all the necessary files.
For command line help: $ bourbon help or visit the Command line tools wiki

Install (Bourbon v3.0+)
gem install bourbon

Install Bourbon into the current directory by generating the bourbon folder:

bourbon install

The generated folder will contain all the mixins and other necessary Bourbon files. It is recommended not to add or modify the Bourbon files so that you can update Bourbon easily.

You can specify a target directory using the path flag:

bourbon install --path my/custom/path/
Import

Lastly, import the mixins at the beginning of your stylesheet(s):

@import 'bourbon/bourbon';

Note: Bourbon no longer requires a custom sass --watch command for Bourbon v3.0+

Other Commands

Visit the Command line tools wiki for a complete list

bourbon help
bourbon update
Bourbon v2.x install instructions

Chat with us

Gitter chat

Credits

thoughtbot

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

Bourbon is Copyright © 2011-2013 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.

Something went wrong with that request. Please try again.