A metalsmith plugin based on Giacomo Martino's uncss
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.gitignore
README.md
package.json

README.md

Metalsmith UnCSS

A metalsmith plugin based on Giacomo Martino's uncss

Installation

  1. Install the package with npm
npm install --save metalsmith-uncss
  1. Include metalsmith-uncss in your Metalsmith project dependencies
var uncss = require('metalsmith-uncss');

Usage

Add uncss to your Metalsmith pipeline

var Metalsmith = require('metalsmith');
var uncss = require('metalsmith-uncss');

Metalsmith(__dirname)
	.source('./src')
	.destination('./dest')
	.use(uncss({
		css: ['bootstrap.css','app.css'],	// CSS files to run through UnCSS
		html: ['index.html','test.html'],	// HTML files to test the CSS files against
		output: 'uncss-output.css',			// output CSS filename
		basepath: 'styles',					// optional base path where all your css files are stored
		removeOriginal: true,				// remove original CSS files from the build
		uncss: {							// uncss options - passed directly to UnCSS
			ignore: ['.added-at-runtime','#do-not-remove']
		}
	}))
	.build();

Options

css

String | Array required

A string or array of CSS files to check against the input HTML files. Files will be concatenated by UnCSS in the order that they are supplied.

This is a required option

UnCSS usually works by detecting CSS files linked in the header of the supplied HTML files. However, because at this stage of the process the CSS files only exist as part of Metalsmith's build pipeline, UnCSS won't be able to find them. To get around this, it's necessary to override the default behaviour and manually pass the file contents through to UnCSS as the raw option.

html

String | Array optional

The HTML files that UnCSS will check CSS files against. If not specified, this defaults to every HTML file currently in the project build pipeline. These are passed to UnCSS as the files argument.

output

String required

The name of the output file.

basepath

String optional

Optional base path that will be prepended to all css files (i.e. those supplied by css and output options).

For example:

// Without basepath
.use(uncss({
	css: ['styles/bootstrap.css','styles/app.css'],
	output: 'styles/uncss-output.css'
}))

// With basepath
.use(uncss({
	css: ['bootstrap.css','app.css'],
	output: 'uncss-output.css',
	basepath: 'styles'
}))

removeOriginal

Boolean optional

Remove the original CSS files (i.e. those supplied by css) from the build pipeline. Defaults to true.

uncss

Object optional

Object of options to pass to UnCSS as the options argument. Supports all options except for raw, which metalsmith-uncss uses to feed in css files from its css option (see above).