/toolkit

Sky's CSS Toolkit

Primary LanguageHTMLBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

npm version Circle CI

Toolkit

Sky's CSS Toolkit.

Goals

  • Enable teams across tribes to share common styles.
  • Provide a modular approach to handling CSS/Sass components.
  • Provide a single source of truth for Polaris brand guidelines.

Structure

The project consists of 3 repositories:

  • this repo: provides the UI and Core layers.
  • toolkit-core: Global styles and defaults for all projects.
  • toolkit-ui: Aesthetic components.

Libraries

Installation

$ npm install sky-toolkit --save

See the Wiki for full documentation and information on how to implement the Toolkit in your project.

Compiled

For rapid prototyping and static sites you can include our latest compiled CSS in the <head> of your page.

<link rel="stylesheet" href="https://www.sky.com/assets/toolkit/v1.0.0/toolkit.css">

We strongly advise not to use this method in live projects. Use npm installation to benefit from the Toolkit's modularity and extensibility.

Requirements

Because of how the Toolkit loads third party dependencies (such as sass-mq), your development environment needs:

  • npm (3.0 or greater)
  • NodeJS (5.0 or greater)

If you're using webpack you'll also need:

Versioning

The Toolkit follows Semantic Versioning to help manage the impact of releasing new library versions.

Champions

| Joe Bell
Joe Bell

| Joe Dinsdale
Joe Dinsdale

| Aaron Thomas
Aaron Thomas

| Steve Duffin
Steve Duffin

| Sam Kitson
Sam Kitson

| Luke Barratt
Luke Barratt

| :---: | :---: | :---: | :---: | :---: | :---: | :---: |

| Greg Pratt
Greg Pratt

| Rich Gorman
Rich Gorman

| Alex Fenton
Alex Fenton

| Chris Vernon
Chris Vernon

| Stefan McCready
Stefan McCready

| Djenan Kozic
Djenan Kozic

| | :---: | :---: | :---: | :---: | :---: | :---: | :---: |

Contributing

We appreciate any contribution to the Toolkit, please check out CONTRIBUTING.md.

We keep a list of features and bugs in the issue tracker.

Special thanks to the following contributors: