spork-css documentation

spork-css is a simple and lighweight css framework that is customizable and extendable. This is a work in progress and not a fully fledged framework.

About

The name of this project is based on a repo name randomy generated by Github called "Glowing Spork", and is a play on the words Spoon and Fork.

The aim of this library is to primarily learn building a css library based on scss, and publshing as a resuable package on npm.

Installation

Run the below command from your project root directory (where package.json is present) to add the library to your project.

npm i spork-css

Usage

Import and include the spork scss file into your scss file. Then use the generated css file into your html project. See the test/ folder in the repo for reference.

// Import the library  
@import '~/spork-css';

Advanced Usage

// Override any theme variables here

// Import the library  
@import '~/spork-css';

Variables

See the Customize page