npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

metalsmith-uncss

v0.2.0

Published

Run uncss from metalsmith

Downloads

7

Readme

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).