Skip to content
This repository was archived by the owner on Feb 3, 2020. It is now read-only.

Commit 9fdc940

Browse files
committed
redirect to purgecss repository
1 parent b799387 commit 9fdc940

File tree

1 file changed

+3
-87
lines changed

1 file changed

+3
-87
lines changed

README.md

+3-87
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,9 @@
11
# PostCSS Purgecss
2-
[![Build Status](https://travis-ci.org/FullHuman/postcss-purgecss.svg?branch=master)](https://travis-ci.org/FullHuman/postcss-purgecss)
3-
[![CircleCi](https://circleci.com/gh/FullHuman/postcss-purgecss/tree/master.svg?style=shield)]()
4-
[![dependencies Status](https://david-dm.org/fullhuman/postcss-purgecss/status.svg)](https://david-dm.org/fullhuman/postcss-purgecss)
5-
[![devDependencies Status](https://david-dm.org/fullhuman/postcss-purgecss/dev-status.svg)](https://david-dm.org/fullhuman/postcss-purgecss?type=dev)
6-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2554f9858cb742ed93eb22f49ccec3c3)](https://www.codacy.com/app/FullHuman/postcss-purgecss?utm_source=github.com&utm_medium=referral&utm_content=FullHuman/postcss-purgecss&utm_campaign=Badge_Grade)
7-
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/2554f9858cb742ed93eb22f49ccec3c3)](https://www.codacy.com/app/FullHuman/postcss-purgecss?utm_source=github.com&utm_medium=referral&utm_content=FullHuman/postcss-purgecss&utm_campaign=Badge_Coverage)
8-
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
9-
[![npm](https://img.shields.io/npm/v/postcss-purgecss.svg)](https://www.npmjs.com/package/@fullhuman/postcss-purgecss)
10-
[![license](https://img.shields.io/github/license/fullhuman/postcss-purgecss.svg)]() [![Greenkeeper badge](https://badges.greenkeeper.io/FullHuman/postcss-purgecss.svg)](https://greenkeeper.io/)
112

12-
[PostCSS] plugin for PurgeCSS.
13-
14-
[PostCSS]: https://github.com/postcss/postcss
15-
16-
## Installation
3+
The contents of this repository were moved into the
4+
[PurgeCSS](https://github.com/FullHuman/purgecss) repository. The source code can be
5+
found in [packages/postcss-purgecss](https://github.com/FullHuman/purgecss/tree/master/packages/postcss-purgecss).
176

187
```
198
npm i -D @fullhuman/postcss-purgecss
209
```
21-
22-
## Usage
23-
24-
```js
25-
const purgecss = require('@fullhuman/postcss-purgecss')
26-
postcss([
27-
purgecss({
28-
content: ['./src/**/*.html']
29-
})
30-
])
31-
```
32-
33-
See [PostCSS] docs for examples for your environment.
34-
35-
## Options
36-
37-
All of the options of purgecss are available to use with the plugins.
38-
You will find below the main options available. For the complete list, go to the [purgecss documentation website](https://www.purgecss.com/configuration.html#options).
39-
40-
### `content` (**required**)
41-
Type: `string | Object`
42-
43-
You can specify content that should be analyzed by Purgecss with an array of filenames or globs. The files can be HTML, Pug, Blade, etc.
44-
45-
### `extractors`
46-
Type: `Array<Object>`
47-
48-
Purgecss can be adapted to suit your needs. If you notice a lot of unused CSS is not being removed, you might want to use a custom extractor.
49-
More information about extractors [here](https://www.purgecss.com/extractors.html).
50-
51-
### `whitelist`
52-
Type: `Array<string>`
53-
54-
You can whitelist selectors to stop Purgecss from removing them from your CSS. This can be accomplished with the options whitelist and whitelistPatterns.
55-
56-
### `whitelistPatterns`
57-
Type: `Array<RegExp>`
58-
59-
You can whitelist selectors based on a regular expression with whitelistPatterns.
60-
61-
### `rejected`
62-
Type: `boolean`
63-
Default value: `false`
64-
65-
If true, purged selectors will be captured and rendered as PostCSS messages.
66-
Use with a PostCSS reporter plugin like [`postcss-reporter`](https://github.com/postcss/postcss-reporter)
67-
to print the purged selectors to the console as they are processed.
68-
69-
### `keyframes`
70-
Type: `boolean`
71-
Default value: `false`
72-
73-
If you are using a CSS animation library such as animate.css, you can remove unused keyframes by setting the keyframes option to true.
74-
75-
#### `fontFace`
76-
Type: `boolean`
77-
Default value: `false`
78-
79-
If there are any unused @font-face rules in your css, you can remove them by setting the fontFace option to true.
80-
81-
## Contributing
82-
83-
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of
84-
conduct, and the process for submitting pull requests to us.
85-
86-
## Versioning
87-
88-
postcss-purgecss use [SemVer](http://semver.org/) for versioning.
89-
90-
## License
91-
92-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
93-
for details.

0 commit comments

Comments
 (0)