Skip to content

mehrdadrafiee/bourbon

 
 

Repository files navigation

Bourbon Sass Mixin Library

Gem Version Code Climate Gitter chat Stack Overflow


A simple and 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.

Requirements

  • Sass 3.3+

⚠️ If you are using LibSass or sass-rails, or need Sass 3.2 support, use Bourbon 3.2.x.

Installation for Rails 3.1+

  1. In your Gemfile:
gem 'bourbon'
  1. Then run:
bundle install
  1. Restart your server and rename application.css to application.css.scss:
mv app/assets/stylesheets/application.css app/assets/stylesheets/application.css.scss
  1. Delete the sprocket directive in application.css.scss (Why?):
*= require_tree .
  1. Import Bourbon at the beginning of application.css.scss. All additional stylesheets should be imported below Bourbon:
@import "bourbon";
@import "home";
@import "users";

Help! I’m getting an undefined mixin error.

Installation for Non-Rails projects

Bourbon includes an easy way to generate a directory with all the necessary files. For command line help, use bourbon help or visit the Command Line Tools Wiki.

  1. Install (Bourbon 3.0+):
gem install bourbon
  1. 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/
  1. Import Bourbon at the beginning of your stylesheet:
@import "bourbon/bourbon";

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

Other Commands

bourbon help
bourbon update

The Bourbon family

  • Bourbon: A simple and lightweight mixin library for Sass
  • Neat: A lightweight semantic grid framework for Sass and Bourbon
  • Bitters: Scaffold styles, variables and structure for Bourbon projects
  • Refills: Prepackaged patterns and components, built on top of Bourbon, Bitters & Neat

Credits

thoughtbot

Bourbon is maintained and funded by thoughtbot, inc. Tweet your questions or suggestions to @phillapier or @thoughtbot.

License

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

About

A simple and lightweight mixin library for Sass.

Resources

License

Stars

Watchers

Forks

Packages

No packages published