iambacon / Styles

A pattern library for iambacon websites.

Styles

Welcome to Styles, the pattern library for iambacon websites.

Table of contents

• Styles
  • Table of contents
  • Getting Started
    • Prerequisites
    • Installation
      • Clone the repo
      • Install npm dependencies
      • Run Styles
  • Usage
  • License
  • Acknowledgements

Getting Started

To get Styles running locally, follow these steps.

Prerequisites

You'll need Git and Node.js installed to get this project running.

Installation

Clone the repo

git clone https://github.com/iambacon/Styles.git

Install npm dependencies

npm install

Run Styles

This will build, serve and watch for changes. Browse to your local instance at http://localhost:8080.

npm start

Usage

To use Styles in your project you will need to generate the CSS file locally.

npm run build

A minified CSS file will be output to dist/css/style.css.

License

Distributed under the MIT License.

Acknowledgements

If you would like to read more about why I created a pattern library and the technology choices I made, please read this post I've finally created UI documentation for my blog with 11ty!