jsit/neat

A lightweight and flexible Sass grid

A lightweight and flexible Sass grid

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.

Helpful Links

• Demo
• Documentation
• Change log
• Twitter
• Stack Overflow

Table of Contents

• Requirements
• Installation
• Command Line Interface
• The Bourbon Family
• Contributing
• License
• About

Requirements

• Sass 3.4+ or LibSass 3.3+

Installation

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

gem install neat

Alternatively, you can install Neat with Bower.

1. Install or update Neat’s dependencies:

gem install sass # or gem update sass

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

neat install --path my/custom/path/

1. Install the Neat library into the current directory:

neat install

1. 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.

Installation for Ruby on Rails 4.2+

1. Add Neat to your Gemfile:

gem "neat"

1. Then run:

bundle install

If you see the error Bundler could not find compatible versions for gem "sass", run:

bundle update sass

1. 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.

Installing with npm and using a Node-based asset pipeline

1. Add Neat as a dependency:

npm install --save bourbon-neat

1. If you’re using eyeglass, skip to Step 3. Otherwise, you’ll need to add Neat to your node-sass includePaths option. require("bourbon-neat").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.

2. Import Neat into your Sass files:

@import "neat";

Installing older versions of Neat

1. Uninstall any Neat gem versions you already have:

gem uninstall neat

1. Reinstall the Neat gem, using the -v flag to specify the version you need:

gem install neat -v 1.8.1

1. Follow the instructions above to install Neat into your project.

Command Line Interface

neat [options]

Options

Option	Description
-h, --help	Show help
-v, --version	Show the version number
--path	Specify a custom path
--force	Force install (overwrite)

Commands

Command	Description
neat install	Install Neat into the current directory
neat update	Overwrite and update Neat in the current directory
neat remove	Removes Neat from the current directory
neat help	Show help
neat version	Show the version number

The Bourbon family

• Bourbon: A lightweight Sass tool set
• Bitters: Scaffold styles, variables and structure for Bourbon projects
• Refills: Components and patterns built with Bourbon and Neat

Contributing

See the contributing document. Thank you, contributors!

License

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

About

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.