Skip to content

Commit e0f576d

Browse files
committed
Docs: Clarify logging in Node API (#637)
1 parent 18a286c commit e0f576d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/API.md

+7
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,11 @@ Using a JavaScript object:
1818
```javascript
1919
const styleguidist = require('react-styleguidist');
2020
const styleguide = styleguidist({
21+
logger: {
22+
warn: console.warn,
23+
info: console.log,
24+
debug: console.log,
25+
},
2126
components: './lib/components/**/*.js',
2227
webpackConfig: {
2328
module: {
@@ -37,6 +42,8 @@ const styleguide = styleguidist({
3742
});
3843
```
3944

45+
**Note:** any output is disabled by default, you may need to define your own [logger](Configuration.md#logger).
46+
4047
Using a config file:
4148

4249
```javascript

0 commit comments

Comments
 (0)