docs(README): add option types && links (#303)

webpack-contrib · Oct 14, 2017 · d39b84e · d39b84e
1 parent 58e9996
commit d39b84e
Showing 1 changed file with 18 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ npm i -D postcss-loader
 
 <h2 align="center">Usage</h2>
 
-### `Config`
+### `Configuration`
 
 **postcss.config.js**
 ```js
@@ -108,15 +108,15 @@ module.exports = {
 
 <h2 align="center">Options</h2>
 
-|Name|Default|Description|
-|:--:|:-----:|:----------|
-|`exec`|`undefined`|Enable PostCSS Parser support in `CSS-in-JS`|
-|`parser`|`undefined`|Set PostCSS Parser|
-|`syntax`|`undefined`|Set PostCSS Syntax|
-|`stringifier`|`undefined`|Set PostCSS Stringifier|
-|`config`|`undefined`|Set `postcss.config.js` config path && `ctx`|
-|`plugins`|`[]`|Set PostCSS Plugins|
-|`sourceMap`|`false`|Enable Source Maps|
+|Name|Type|Default|Description|
+|:--:|:--:|:-----:|:----------|
+|[`exec`](#exec)|`{Boolean}`|`undefined`|Enable PostCSS Parser support in `CSS-in-JS`|
+|[`parser`](#syntaxes)|`{String\|Object}`|`undefined`|Set PostCSS Parser|
+|[`syntax`](#syntaxes)|`{String\|Object}`|`undefined`|Set PostCSS Syntax|
+|[`stringifier`](#syntaxes)|`{String\|Object}`|`undefined`|Set PostCSS Stringifier|
+|[`config`](#config)|`{Object}`|`undefined`|Set `postcss.config.js` config path && `ctx`|
+|[`plugins`](#plugins)|`{Array\|Function}`|`[]`|Set PostCSS Plugins|
+|[`sourceMap`](#sourceMap)|`{String\|Boolean}`|`false`|Enable Source Maps|
 
 ### `Exec`
 
@@ -135,6 +135,11 @@ If you use JS styles without the [`postcss-js`][postcss-js] parser, add the `exe
 
 ### `Config`
 
+|Name|Type|Default|Description|
+|:--:|:--:|:-----:|:----------|
+|[`path`](#path)|`{String}`|`undefined`|PostCSS Config Path|
+|[`context`](#context)|`{Object}`|`undefined`|PostCSS Config Context|
+
 #### `Path`
 
 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 }) => ({
 
 |Name|Type|Default|Description|
 |:--:|:--:|:-----:|:----------|
-|`syntax`|`{String\|Function}`|`undefined`|Custom PostCSS Syntax|
-|`parser`|`{String\|Function}`|`undefined`|Custom PostCSS Parser|
-|`stringifier`|`{String\|Function}`|`undefined`|Custom PostCSS Stringifier|
+|[`parser`](#parser)|`{String\|Function}`|`undefined`|Custom PostCSS Parser|
+|[`syntax`](#syntax)|`{String\|Function}`|`undefined`|Custom PostCSS Syntax|
+|[`stringifier`](#stringifier)|`{String\|Function}`|`undefined`|Custom PostCSS Stringifier|
 
 #### `Parser`