Skip to content

Commit da8138e

Browse files
committed
Documentation updates
1 parent 108e47e commit da8138e

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ If set to `true` then the output is minified by [`cssnano`](http://cssnano.co/).
101101
##### `beforeLint`
102102

103103
* Type: `Function`
104-
* Default: `false`
104+
* Default: `undefined`
105105

106106
Called with the imported CSS before it's passed to `postcss-bem-linter`. This allows you to transform the CSS first and it must return the css string.
107107

@@ -116,17 +116,32 @@ Third paramater is the options object containing any PostCSS configuration you m
116116
}
117117
```
118118

119-
##### `config`
119+
##### `use`
120+
121+
* Type: `Array`
122+
* Default: `undefined`
123+
124+
A list of plugins that are passed to PostCSS. This can be used to add new plugins and/or reorder the defaults
125+
126+
```js
127+
{
128+
use: ['stylelint', 'postcss-property-lookup']
129+
}
130+
```
131+
132+
##### `<plugin-name>`
120133

121134
* Type: `Object`
122-
* Default: [various](https://github.com/suitcss/preprocessor/blob/master/lib/index.js#L23)
135+
* Default: `undefined`
123136

124-
A list of plugins and their options that are passed to PostCSS. This can be used to add new plugins and/or configure existing ones.
137+
Property matching the name of a PostCSS plugin that has options for that plugin
125138

126139
```js
127-
config: {
128-
use: ['stylelint', 'postcss-property-lookup'],
129-
autoprefixer: { browsers: ['> 1%', 'IE 7'], cascade: false },
140+
{
141+
autoprefixer: {
142+
browsers: ['> 1%', 'IE 7'],
143+
cascade: false
144+
},
130145
'postcss-calc': { preserve: true }
131146
}
132147
```

0 commit comments

Comments
 (0)