Skip to content

Commit

Permalink
docs(README): clarify path option description (`options.config.path…
Browse files Browse the repository at this point in the history
…`) (#371)
  • Loading branch information
y-gagar1n authored and michael-ciniawsky committed Jul 16, 2018
1 parent 4955792 commit 5c1c108
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ If you use JS styles without the [`postcss-js`][postcss-js] parser, add the `exe

|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|[`path`](#path)|`{String}`|`undefined`|PostCSS Config Path|
|[`path`](#path)|`{String}`|`undefined`|PostCSS Config Directory|
|[`context`](#context)|`{Object}`|`undefined`|PostCSS Config Context|

#### `Path`
Expand All @@ -146,18 +146,23 @@ You can manually specify the path to search for your config (`postcss.config.js`

> ⚠️ Otherwise it is **unnecessary** to set this option and is **not** recommended
> ⚠️ Note that you **can't** use a **filename** other than the [supported config formats] (e.g `.postcssrc.js`, `postcss.config.js`), this option only allows you to manually specify the **directory** where config lookup should **start** from
**webpack.config.js**
```js
{
loader: 'postcss-loader',
options: {
config: {
path: 'path/to/postcss.config.js'
path: 'path/to/.config/'
path: 'path/to/.config/css.config.js'
}
}
}
```

[supported config formats]: https://github.com/michael-ciniawsky/postcss-load-config#usage

#### `Context (ctx)`

|Name|Type|Default|Description|
Expand Down

0 comments on commit 5c1c108

Please sign in to comment.