Skip to content

ZheFeng/bitters

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bitters

Scaffold styles, variables and structure for Bourbon projects.

Bitters is meant to help designers start projects faster by defining a basic set of variables and project structure. After you have Bitters installed, jump in and start customizing the styles and variables to your design and brand requirements.

Bitters should live in your project's sass root folder and be modified and extended while you design your project.

Install Instructions

Install Bitters:

gem install bitters

Install Bourbon (required) and Neat (optional).

Then cd to your Sass directory and run:

bitters install

The generated folder will contain all Bitters files.

Import Bitters after Bourbon in your application.css.scss. All additional stylesheets should be imported below Bitters.

If you are using Neat, import it after Bitters. Be sure to not include any of Neat's mixins or functions in the Bitters files when modifying Bitters.

@import "bourbon";
@import "bitters/bitters";
@import "neat";

// All other imports

Also, when using Neat, have the following lines in "_bitters.scss" uncommented:

@import "neat-helpers"; // or "neat/neat-helpers" when not in Rails
@import "grid-settings";

We suggest using Normalize for a CSS reset with Bitters.

Getting Started

Sass structure & default style

The Bitters folder should contain styles for all the basic elements used throughout the project. It also contains folders for custom mixins and extends for your site as well. Add code to the existing files or add new files to the folders. Customize Bitters for your site as you see fit.

Variables

This houses all variables that are used, or will be used, in more than one file in your site. Variable names in Bitters that are used outside of the variables file start with $base to indicate that they are the most basic variables.

Grid settings

Variables specifically created for Neat resets and breakpoints. To be used, these need to be imported separately from the rest of your base file above Neat in your main stylesheet. Otherwise just remove the file.

Typography

All type is based on $base-font-size which is set to 1em (16px) by default. The spacing around type is based on $base-line-height so as to keep a semi-baseline grid. All sizes are scaled up or down by a factor of .25.

Lists

All lists have stripped out styles. No bullets, no left padding. To add back the expected browser default styles add @extend %default-ul; or @extend %default-ol; to the <ul> or <ol> respectively..

Forms

Adds basic styles all form elements. The variables at the top of the file all inherit from the variables file but make it really easy to be overridden.

Flashes

Used for any error, warning or success messages in applications or forms. Specifically made for rails application notices.

Requirements

  • Sass 3.0+
  • Bourbon 2.0+

Credits

thoughtbot

Bitters is maintained and funded by thoughtbot, inc. Tweet your questions or suggestions at @kylefiedler.

License

Bitters is Copyright © 2014 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

Add a dash of pre-defined style to your Bourbon.

Resources

License

Stars

Watchers

Forks

Packages

No packages published