# Purgecss
[](https://travis-ci.org/FullHuman/purgecss)
[]()
[](https://david-dm.org/fullhuman/purgecss)
[](https://david-dm.org/fullhuman/purgecss?type=dev)
[](https://www.codacy.com/app/FullHuman/purgecss?utm_source=github.com&utm_medium=referral&utm_content=FullHuman/purgecss&utm_campaign=Badge_Grade)
[](https://www.codacy.com/app/FullHuman/purgecss?utm_source=github.com&utm_medium=referral&utm_content=FullHuman/purgecss&utm_campaign=Badge_Coverage)
[](https://github.com/prettier/prettier)
[](https://www.npmjs.com/package/purgecss)
[]() [](https://greenkeeper.io/)
## 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.
## Documentation
You can find the purgecss documentation
[on this website](https://www.purgecss.com).
* [Configuration](https://www.purgecss.com/configuration)
* [CLI](https://www.purgecss.com/cli)
* [Javascript API](https://www.purgecss.com/javascript-api)
* [Webpack plugin](https://www.purgecss.com/with-webpack)
* [Gulp plugin](https://www.purgecss.com/with-gulp)
* [Grunt plugin](https://www.purgecss.com/with-grunt)
* [Rollup plugin](https://www.purgecss.com/with-rollup)
* [Whitelisting](https://www.purgecss.com/whitelisting)
* [Extractors](https://www.purgecss.com/extractors)
* [Comparison](https://www.purgecss.com/comparison)
* Guides
* [React](https://www.purgecss.com/guides/react)
* [Vue](https://www.purgecss.com/guides/vue)
* [Nuxt](https://www.purgecss.com/guides/nuxt)
* [Wordpress](https://www.purgecss.com/guides/wordpress)
## Getting Started
#### Installation
```
npm i --save-dev purgecss
```
## Usage
```js
import Purgecss from 'purgecss'
const purgeCss = new Purgecss({
content: ['**/*.html'],
css: ['**/*.css']
})
const result = purgeCss.purge()
```
With a custom extractor:
```js
import Purgecss from 'purgecss'
import purgeHtml from 'purgecss-from-html'
const purgeCss = new Purgecss({
content: ['**/*.html'],
css: ['**/*.css'],
extractors: [
{
extractor: purgeHtml,
extensions: ['html']
}
]
})
const result = purgeCss.purge()
```
### Build Plugin
* [Webpack](https://www.purgecss.com/with-webpack)
* [Gulp](https://www.purgecss.com/with-gulp)
* [Grunt](https://www.purgecss.com/with-grunt)
* [Rollup](https://www.purgecss.com/with-rollup)
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of
conduct, and the process for submitting pull requests to us.
## Versioning
Purgecss use [SemVer](http://semver.org/) for versioning.
## Acknowledgment
Purgecss was originally thought as the v2 of purifycss. And because of it, it is
greatly inspired by it.\
Some of the plugins such as purgecss-webpack-plugin are based on the purifycss plugin.\
Below is the list of the purifycss repositories:
* [purifycss](https://github.com/purifycss/purifycss)
* [gulp-purifycss](https://github.com/purifycss/gulp-purifycss)
* [purifycss-webpack](https://github.com/webpack-contrib/purifycss-webpack)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
for details.
## Troubleshooting
#### Wrong extractor is selected
The extractors needs to be defined from the more specific to the less specific.
Meaning that you need to define `js` extractor after `ejs`. So the `js`
extractor will not be selected for ejs files.
> You can specified extensions like `.es.js`.
