Skip to content

Commit d39b84e

Browse files
authoredOct 14, 2017
docs(README): add option types && links (#303)
1 parent 58e9996 commit d39b84e

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed
 

‎README.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ npm i -D postcss-loader
3131

3232
<h2 align="center">Usage</h2>
3333

34-
### `Config`
34+
### `Configuration`
3535

3636
**postcss.config.js**
3737
```js
@@ -108,15 +108,15 @@ module.exports = {
108108

109109
<h2 align="center">Options</h2>
110110

111-
|Name|Default|Description|
112-
|:--:|:-----:|:----------|
113-
|`exec`|`undefined`|Enable PostCSS Parser support in `CSS-in-JS`|
114-
|`parser`|`undefined`|Set PostCSS Parser|
115-
|`syntax`|`undefined`|Set PostCSS Syntax|
116-
|`stringifier`|`undefined`|Set PostCSS Stringifier|
117-
|`config`|`undefined`|Set `postcss.config.js` config path && `ctx`|
118-
|`plugins`|`[]`|Set PostCSS Plugins|
119-
|`sourceMap`|`false`|Enable Source Maps|
111+
|Name|Type|Default|Description|
112+
|:--:|:--:|:-----:|:----------|
113+
|[`exec`](#exec)|`{Boolean}`|`undefined`|Enable PostCSS Parser support in `CSS-in-JS`|
114+
|[`parser`](#syntaxes)|`{String\|Object}`|`undefined`|Set PostCSS Parser|
115+
|[`syntax`](#syntaxes)|`{String\|Object}`|`undefined`|Set PostCSS Syntax|
116+
|[`stringifier`](#syntaxes)|`{String\|Object}`|`undefined`|Set PostCSS Stringifier|
117+
|[`config`](#config)|`{Object}`|`undefined`|Set `postcss.config.js` config path && `ctx`|
118+
|[`plugins`](#plugins)|`{Array\|Function}`|`[]`|Set PostCSS Plugins|
119+
|[`sourceMap`](#sourceMap)|`{String\|Boolean}`|`false`|Enable Source Maps|
120120

121121
### `Exec`
122122

@@ -135,6 +135,11 @@ If you use JS styles without the [`postcss-js`][postcss-js] parser, add the `exe
135135

136136
### `Config`
137137

138+
|Name|Type|Default|Description|
139+
|:--:|:--:|:-----:|:----------|
140+
|[`path`](#path)|`{String}`|`undefined`|PostCSS Config Path|
141+
|[`context`](#context)|`{Object}`|`undefined`|PostCSS Config Context|
142+
138143
#### `Path`
139144

140145
You can manually specify the path to search for your config (`postcss.config.js`) with the `config.path` option. This is needed if you store your config in a separate e.g `./config || ./.config` folder.
@@ -216,9 +221,9 @@ module.exports = ({ file, options, env }) => ({
216221

217222
|Name|Type|Default|Description|
218223
|:--:|:--:|:-----:|:----------|
219-
|`syntax`|`{String\|Function}`|`undefined`|Custom PostCSS Syntax|
220-
|`parser`|`{String\|Function}`|`undefined`|Custom PostCSS Parser|
221-
|`stringifier`|`{String\|Function}`|`undefined`|Custom PostCSS Stringifier|
224+
|[`parser`](#parser)|`{String\|Function}`|`undefined`|Custom PostCSS Parser|
225+
|[`syntax`](#syntax)|`{String\|Function}`|`undefined`|Custom PostCSS Syntax|
226+
|[`stringifier`](#stringifier)|`{String\|Function}`|`undefined`|Custom PostCSS Stringifier|
222227

223228
#### `Parser`
224229

0 commit comments

Comments
 (0)
Please sign in to comment.