Skip to content

Commit f95a245

Browse files
docs(README): add option types && links
1 parent 58e9996 commit f95a245

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -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)