@upstatement/upbase v1.0.0

Upbase

A bespoke Sass mixin library from Upstatement

Setup

1. Add Upbase to your project using NPM or Yarn.

   # NPM
   npm install @upstatement/upbase
   
   # Yarn
   yarn add @upstatement/upbase

2. Ensure the Upbase scss directory is on your Sass load path.

   If you're using Gulp Sass:

   const gulp = require('gulp');
   const sass = require('gulp-sass');
   
   gulp.task('sass', () => {
     return gulp.src('./scss/**')
       .pipe(sass({
         includePaths: [require('@upstatement/upbase').includePaths],
       }))
       .pipe(gulp.dest('./css'));
   });

3. Import all Upbase helpers into your Sass file before use:

     @import "upbase";

Documentation

All mixins are documented using SassDoc. Visit the hosted docs at http://upbase.upstatement.com/.

Contributing

We welcome all contributions to our projects! Filing bugs, feature requests, code changes, docs changes, or anything else you'd like to contribute are all more than welcome! More information about contributing can be found in the contributing guidelines.

Code of Conduct

Upstatement strives to provide a welcoming, inclusive environment for all users. To hold ourselves accountable to that mission, we have a strictly-enforced code of conduct.

About Upstatement

Upstatement is a digital transformation studio headquartered in Boston, MA that imagines and builds exceptional digital experiences. Make sure to check out our services, work, and open positions!