@carbongos/style-guide

Defines the style guide for use across Carbongos products.

Usage no npm install needed!

<script type="module">
  import carbongosStyleGuide from 'https://cdn.skypack.dev/@carbongos/style-guide';
</script>

README

Style Guide

Defines the style guide for use across Carbongos products.

Style

Colours

Our brand colours are defined in styles colours.scss.

NPM & Deployment

This project automatically publishes to npm here: https://www.npmjs.com/package/@carbongos/style-guide on merge into the master branch. (See .github/workflows/publish.yml).

Usage

  1. install the package
npm i -S @carbongos/style-guide
  1. import inside of an scss block
@import '@carbongos/style-guide';
  1. use the variables in your code, i.e.:
{
    h1: {
        color: $colour-primary;
    }
}