Skip to content

Commit 762e412

Browse files
Merge pull request #5 from hipstersmoothie/hipstersmoothie-patch-2
Update readme.md
2 parents dd96adb + 3dad275 commit 762e412

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ yarn add -D react-docgen-typescript-plugin
1919
> `react-docgen-typescript-plugin` a lot harder! Turn them off for faster build times.
2020
2121
```ts
22+
const ts = require('typescript');
2223
const ReactDocgenTypescriptPlugin = require("react-docgen-typescript-plugin");
2324

2425
module.exports = {
@@ -43,8 +44,8 @@ This plugins support all parser options from [react-docgen-typescript](https://g
4344
| docgenCollectionName | string or null | Specify the docgen collection name to use. All docgen information will be collected into this global object. Set to `null` to disable. | `STORYBOOK_REACT_CLASSES` |
4445
| setDisplayName | boolean | Set the components' display name. If you want to set display names yourself or are using another plugin to do this, you should disable this option. | `true` |
4546
| typePropName | string | Specify the name of the property for docgen info prop type. | `type` |
46-
| exclude | glob[] | Glob patterns to ignore and not generate docgen information for. (Great for ignoring large icon libraries) | [] |
47-
| include | glob[] | Glob patterns to generate docgen information for | ['**/**.tsx'] |
47+
| exclude | glob[] | Glob patterns to ignore and not generate docgen information for. (Great for ignoring large icon libraries) | `[]` |
48+
| include | glob[] | Glob patterns to generate docgen information for | `['**/**.tsx']` |
4849

4950
## Debugging
5051

0 commit comments

Comments
 (0)