@theoryofnekomata/scaffolding

scaffolding

Useful Sass functions and utilities.

Why?

• You only need a small portion of style code.
• You think Sass is cool, and you try using its many features to help you manage styles.
• You want to contribute to the community by providing small snippets of Sass code for others to use.

Installation

(I was thinking what if Sass gets package management of its own somehow.)

In NPM:

$ npm install --save @theoryofnekomata/scaffolding

In Bower

$ bower install --save sass-scaffolding

Usage

(You may need to adjust paths to where the Scaffolding code is installed.)

Using classes:

@import "~/classes/presentation";
@import "~/classes/a11y";

// ...

.clearfixed-element {
  @extend ._clearfix;
}

.screen-reader {
  @extend ._sr-only;
}

Using functions:

@import "~/functions/maps";

$map = (a: (b: (c: 'Hello world'))); // complex map

// ...

.hello-element {
  &::after {
    content: deep-get($map, 'a.b.c');
    display: block;
  }
}

Notes

The classes use rstacruz's rscss paradigm in order for all of them to become manageable and compact.

Docs should be built once there are changes to the codebase. Please run npm run build:docs. You may need to install sassdoc first.

License

MIT. See LICENSE file for details.