/purgecss

Remove unused CSS

Primary LanguageTypeScriptMIT LicenseMIT

PurgeCSS

David David Dependabot npm npm GitHub

PurgeCSS logo

What is PurgeCSS?

When you are building a website, chances are that you are using a css framework like Bootstrap, Materializecss, Foundation, etc... But you will only use a small set of the framework and a lot of unused css styles will be included.

This is where PurgeCSS comes into play. PurgeCSS analyzes your content and your css files. Then it matches the selectors used in your files with the one in your content files. It removes unused selectors from your css, resulting in smaller css files.

Version 1

If you are looking for PurgeCSS 1, the documentation is here

Documentation

You can find the PurgeCSS documentation on this website.

Table of Contents

PurgeCSS

Plugins

Guides

Getting Started

Installation

npm i --save-dev purgecss

Usage

import PurgeCSS from 'purgecss'
const purgeCSSResults = await new Purgecss().purge({
  content: ['**/*.html'],
  css: ['**/*.css']
})

Packages

This repository is a monorepo that we manage using Lerna. That means that we actually publish several packages to npm from the same codebase, including:

Package Version Description
purgecss The core of PurgeCSS
postcss-purgecss PostCSS plugin for PurgeCSS
purgecss-webpack-plugin Webpack plugin for PurgeCSS
gulp-purgecss Gulp plugin for PurgeCSS
grunt-purgecss Grunt plugin for PurgeCSS
purgecss-from-html Html extractor for PurgeCSS
purgecss-from-js Js extractor for PurgeCSS
purgecss-from-pug Pug extractor for PurgeCSS
purgecss-with-wordpress Collection of whitelist items for WordPress