Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.93 KB

README.md

File metadata and controls

58 lines (40 loc) · 1.93 KB

harp-bitters

Add a dash of predefined style to get your Bourbon stylesheets started off in the right direction.

Dependencies

  • Node.jsServer-side JavaScript runtime
  • HarpThe static web server with built-in preprocessing

Install

To install Bitters, you can download this repository or use the Component package manager.

npm install -g component
component install harp/bitters
harp install bitters

Your project will look something like this…

myproject/                  <-- Your project root (or public dir if in framework-mode)
  |- components/            <-- Harp puts components here
  |   +- harp-bourbon/      <-- Where Bourbon gets installed
  |   +- harp-bitters/      <-- Where this lib gets installed
  |       …
  |- main.scss              <-- Where you reference Bourbon and Bitters
  +- index.jade             <-- Where you reference main.css

Link

Now, from within a .scss file in your project, you can @import Bourbon and Bitters:

@import "components/harp-bourbon/scss/bourbon";
@import "components/harp-bitters/scss/bitters";

Or, just a portion of either:

@import "components/harp-bourbon/scss/bourbon";
@import "components/harp-bitters/scss/variables";
@import "components/harp-botters/forms";

A note on @extends

Bitters makes use of @extends in Sass, which isn’t supported in libsass, and therefore Harp yet. This means %button, %default-ul and %default-ol can only be used with real classes (.button, .default-ul, .default-ol) in the meantime. This will be reverted as soon as libsass supports this feature, which should be very soon.

License

This component is Bitters, which is Copyright © 2013 thoughtbot and MIT licensed.