Skip to content

Commit bc24430

Browse files
authored
Merge pull request #276 from andreyvolokitin/patch-1
docs: clarify external config format
2 parents e725594 + c673d18 commit bc24430

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@
151151
"test/**",
152152
"tmp/**",
153153
"lib/**",
154+
".idea/**",
154155
"*.{html,jpg}"
155156
],
156157
"rules": {

readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,18 @@ $ posthtml --help
3939
4040
> **Note:** Automatically loads plug-ins with configuration from package.json using [post-load-plugins](https://github.com/post-org/post-load-plugins) if not used `--auto-off` key
4141
42+
Also note that in case of using external config file, the config itself needs to be contained inside "posthtml" key:
43+
```js
44+
module.exports = {
45+
posthtml: {
46+
plugins: {
47+
'posthtml-plugin': {
48+
foo: 'bar'
49+
}
50+
}
51+
}
52+
};
53+
```
4254

4355
[posthtml-url]: http://github.com/posthtml/posthtml
4456

0 commit comments

Comments
 (0)