bourbon-bitters

[no longer maintained]

Showing:

Popularity

Downloads/wk

105

GitHub Stars

4.5K

Maintenance

Last Commit

2yrs ago

Contributors

69

Package

Dependencies

5

Size (min+gzip)

0.2KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Neat logo

Reviewed by Hound

A lightweight and flexible Sass grid

Note: This project is no longer maintained. We favor and encourage people to use native CSS features like Grid and Flexbox. Float-based grid frameworks like Neat are no longer necessary.

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.

Table of Contents

Requirements

Installation

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

    gem install neat
    
  2. 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/
    
  3. Install the Neat library into the current directory:

    neat install
    
  4. 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"
    
  2. Then run:

    bundle install
    

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

    bundle update sass
    
  3. 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
    
  2. 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.

  3. 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
    
  2. Reinstall the Neat gem, using the -v flag to specify the version you need:

    gem install neat -v 1.8.1
    
  3. Follow the instructions above to install Neat into your project.

Command Line Interface

neat [options]

Options

OptionDescription
-h, --helpShow help
-v, --versionShow the version number
--pathSpecify a custom path
--forceForce install (overwrite)

Commands

CommandDescription
neat installInstall Neat into the current directory
neat updateOverwrite and update Neat in the current directory
neat removeRemoves Neat from the current directory
neat helpShow help
neat versionShow the version number

The Bourbon family

  • Bourbon: A lightweight Sass tool set

  • Bitters: Scaffold styles, variables and structure for Bourbon projects

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.

thoughtbot logo

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100