@buildit/gravy

Gravy is a SCSS foundation library

Q: What is a foundation library?

A: Is a library that provides basic essential rules, normalisation, basic elements styles, and additional mixins and allows to create a starting point for a UI library.

Q: Why Gravy?

A: Because it gives flavour to what you have on your plate without much effort... What kind of question is this?

Technical notes

Dependencies

This library depends on the following libraries:

• Normalize-scss as a SCSS module for Normalize.css .
• Modularscale-sass for typography following Modular Scale principles.
• Typi for responsive typography and vertical rhythm.

The dependencies are meant to aleviate the amount of effort to achieve a particular solution. If you feel like there's a reason to ditch a particular dependency in favour of a localised solution, please open a bug request.

Installation

Install the library via npm, the usual way:

$ npm install @buildit/gravy

If you have Eyeglass installed, you can simply include the symbol Gravy exports to your main scss file:

@include "gravy";

Once that's done, you can start configuring it by overriding the needed variables and maps.

Configuration

The configuration has been split in different section to make it more easy to follow.

• Colours
• Breakpoints
• Typography and Vertical Rhythm
• Headings
• Mixins and Functions
• Helpers

Contribute & support

You can contribute to the development of this library in many ways:

• submitting bug reports,
• opening PRs,
• getting in touch with our core developers if none the above works (we'll try to answer all of your love letters!).

NOTE Be sure to enable stylelint in your preferred IDE/Editor, or run npm test before pushing and opening a PR: any PR submitted that doesn't lint correctly will be rejected.