A Lightweight Sass Tool Set:
Ruby Cucumber CSS JavaScript
Latest commit 7a55310 Jul 22, 2016 @tysongach tysongach Restructure documentation examples
We currently use SassDoc's `@example` annotation by putting the Sass
within the first `@example` block, and then the output CSS in a second
`@example` block.

This is a bit confusing to follow input/output when a feature has
multiple examples.

This also means that we can't describe individual examples very well
since SassDoc supports a description per `@example` block.

Since SassDoc doesn't currently have the concept of input/output, this
commit encapsulated each example in its own `@example` block, using a
CSS comment to indicate the output.

With this change, the documentation site can have a better understanding
of what an example is, and easily loop through multiple consistent
examples.

README.md

Bourbon

GitHub release CircleCI branch

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.

Follow the @bourbonsass Twitter account for updates.

Requirements

Installation

For command line help, visit our wiki page on Bourbon’s command line interface.

  1. Install the Bourbon gem using the RubyGems package manager:

    gem install bourbon

    Alternatively, you can install Bourbon with Bower.

  2. Install the Bourbon library into the current directory:

    bourbon install

    Pro Tip: You can target installation into a specific directory using the path flag:

    bourbon install --path my/custom/path/
  3. 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 them easily.

Installation for Ruby on Rails 4.2+

  1. Add Bourbon to your Gemfile:

    gem 'bourbon'
  2. Then run:

    bundle install
  3. Restart your server and rename application.css to application.scss:

    mv app/assets/stylesheets/application.css app/assets/stylesheets/application.scss
  4. Delete all Sprockets directives in application.scss (require, require_tree and require_self) and use Sass’s native @import instead. (why?)

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

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

    Help! I’m getting an undefined mixin error.

Installing with npm and using a Node-based asset pipeline

  1. Add Bourbon as a dependency:

    npm install --save bourbon
  2. If you’re using Eyeglass, skip to Step 3. Otherwise, you’ll need to add Bourbon to your node-sass includePaths option. require("bourbon").includePaths is an array of directories that you should pass to node-sass. How you do this depends on how node-sass is integrated into your project.

  3. Import Bourbon into your Sass files:

    @import "bourbon";

Installing older versions of Bourbon

  1. Uninstall any Bourbon gem versions you already have:

    gem uninstall bourbon
  2. Reinstall the Bourbon gem, using the -v flag to specify the version you need:

    gem install bourbon -v 3.2.4
  3. Follow the instructions above to install Bourbon into your project.

Browser support

  • Chrome 26+
  • Firefox 29+
  • Internet Explorer 9+
  • Opera 15+
  • Safari 6.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 with Bourbon, Neat and Bitters

Also check out Proteus, a collection of useful starter kits to help you prototype faster. Each kit comes with Bourbon, Neat and Bitters out-of-the-box.

Contributing

See the contributing document. Thank you, contributors!

License

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

About

Bourbon is maintained by Tyson Gach and the thoughtbot design team. It is funded by thoughtbot, inc. and the names and logos for thoughtbot are trademarks of thoughtbot, inc.

thoughtbot logo

We love open-source software! See our other projects or hire us to design, develop, and grow your product.