Giter Club home page Giter Club logo

bitters's Introduction

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.

bitters's People

Contributors

alexbaldwin avatar edwardloveall avatar henrik avatar kylefiedler avatar tyre avatar vis-kid avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.