Theming codekit

This repository provides a series of tools and build scripts useful for developing resources that would be used to theme web content.

Table of contents

• Quick start
• What's included
• Bugs and feature requests
• Documentation

Quick start

• Download the latest release or clone the repo: git clone https://github.com/David-Corbett/theming-codekit.git
• npm install

What's included

The kit uses NPM scripts and packages to create tooling to:

• write and compile scss to css
• apply appropriate prefixing for css rules
• write and uglify js
• detect features the user’s browser has to offer (via Modernizr)
• code linting
• optimise and compress images for the web
• living style guide for the code via kss

Within the download you'll find the following directories and files, logically grouping common assets, you'll see something like this:

theming-codekit/
└── config/
│   ├── .sass-lint.yml
│   ├── modernizr-config.json
└── docs/
└── src/
│   ├── images/
│   ├── js/
│   ├── scss/
│   ├── styleguide/
└── .gitignore
└── mkdocs.yml
└── package.json
└── README.md

Using the NPM scripts

The package.json includes the following commands and tasks:

Task	Description
npm run build	npm run build compiles files into their build directories ready for use in a production environment. Uses Sass, Autoprefixer, Modernizr and UglifyJS.
npm run watch	Watches for changes to scss and js files & compiles them for development purposes.
npm run lint	Will run all .scss and .js files through their respective linting tools - eslint & sass-lint
npm run lint-scss	Will run all .scss files through sass-lint. The command can also accept a parameter to lint an individual file. To do this npm run lint-scss -- scssfile:name-of-file where name-of-file is the file you want to lint relative to the package.json for the project.

Run npm run to see all the npm scripts.

Documentation

TODO: add about how this documented Documentation for how to use the tools and scripts provided in this repo are available at https://david-corbett.github.io/theming-codekit/.

Running documentation locally

1. TODO: add how to view documentation locally