Neat is a fluid grid framework with the aim of being easy enough to use out of the box and flexible enough to customize down the road.
Follow the @bourbonsass Twitter account for updates.
- Sass 3.4+ or LibSass 3.3+
For command line help, visit our wiki page on Neat’s command line interface.
- Install the Neat gem using the RubyGems package manager:
gem install neatAlternatively, you can install Neat with Bower.
- Install or update Neat’s dependencies:
gem install sass # or gem update sass- Install the Neat library into the current directory:
neat install- Import Neat in your stylesheet:
@import "neat/neat";It’s not recommended to add or modify the Neat files so that you can update them easily.
- Add Neat to your Gemfile:
gem "neat"- Then run:
bundle installIf you see the error Bundler could not find compatible versions for gem "sass", run:
bundle update sass- Import Neat in your
application.scss:
@import "neat";It should be noted that @import rules are not compatible with Sprockets directives. You need to use one or the other.
- Add Neat as a dependency:
npm install --save bourbon-neat-
If you’re using Eyeglass, skip to Step 3. Otherwise, you’ll need to add Neat to your node-sass
includePathsoption.require("bourbon-neat").includePathsis 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. -
Import Neat into your Sass files:
@import "neat";- Uninstall any Neat gem versions you already have:
gem uninstall neat- Reinstall the Neat gem, using the
-vflag to specify the version you need:
gem install neat -v 1.8.1- Follow the instructions above to install Neat into your project.
- Bourbon: A lightweight Sass tool set
- Neat: A lightweight and flexible Sass grid
- Bitters: Scaffold styles, variables and structure for Bourbon projects
- Refills: Prepackaged patterns and components built with Bourbon, Neat and Bitters
See the contributing document. Thank you, contributors!
Neat is copyright © 2012 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the license.
Neat is maintained by the thoughtbot design team. It is funded by thoughtbot, inc. and the names and logos for thoughtbot are trademarks of thoughtbot, inc.
We love open-source software! See our other projects or hire us to design, develop, and grow your product.