Giter Club home page Giter Club logo

bourbon's Introduction

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 Bourbon with LibSass, sass-rails, Compass, Foundation or need Sass 3.2 support, you should use Bourbon 3.2.x.

Installation

Bourbon uses the RubyGems package manager to easily generate a bourbon directory with all of the necessary files.

For command line help, use bourbon help or visit the Command Line Interface Wiki.

  1. Install the Bourbon gem:
gem install bourbon
  1. Install the Bourbon library into the current directory:
bourbon install

Pro Tip: 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";

It’s not recommended to add or modify the Bourbon files so that you can update Bourbon easily.

Installation for Rails 3.1+

  1. Add Bourbon to 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.

Installing older versions of Bourbon

  1. Uninstall any Bourbon gem versions you already have:
gem uninstall bourbon
  1. Reinstall the Bourbon gem, using the -v flag to specify the version you need:
gem install bourbon -v 3.2.3
  1. Follow the instructions above to install Bourbon into your project.

Command line interface

bourbon help
bourbon install
bourbon update
bourbon version

More information can be found in the wiki.

Browser support

  • Chrome 10.0+
  • Firefox 3.6+
  • Internet Explorer 9+
  • Opera 12+
  • Safari 5.1+

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 @bourbonsass and while you’re at it follow us too.

License

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

bourbon's People

Contributors

bmorrall avatar borodean avatar glovertom avatar hmps avatar hotmeteor avatar jamiebuilds avatar kennethormandy avatar knuton avatar kylefiedler avatar lifeiscontent avatar mab879 avatar matiassingers avatar mattbrictson avatar mendozagioo avatar metaskills avatar mike-burns avatar mikesusz avatar mikeymike avatar mjankowski avatar mondoreale avatar mrb avatar mschmidt avatar msonnabaum avatar nickrivadeneira avatar octave avatar qrush avatar renaudleo avatar sikachu avatar thibaut avatar travishaynes avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.