GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 05:41:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5929 from dfee/patch-3

Browse Source 
updated docs to reflect proper params passed to webpack.config.js
This commit is contained in:
Michael Shilman 2019-03-07 12:10:37 +08:00 committed by Michael Shilman
parent c919b89cdc
commit dd03c290c5
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/src/pages/configurations/typescript-config/index.md
View File

@ -30,20 +30,20 @@ module.exports = ({ config, mode }) => {
test: /\.(ts|tsx)$/, test: /\.(ts|tsx)$/,
use: [ use: [
{ {
loader: require.resolve('awesome-typescript-loader') loader: require.resolve('awesome-typescript-loader'),
}, },
// Optional // Optional
{ {
loader: require.resolve('react-docgen-typescript-loader') loader: require.resolve('react-docgen-typescript-loader'),
} },
] ],
}); });
config.resolve.extensions.push('.ts', '.tsx'); config.resolve.extensions.push('.ts', '.tsx');
return config; return config;
}; };
``` ```
The above example shows a working Webpack config with the [TSDocgen plugin](https://github.com/strothj/react-docgen-typescript-loader) integrated. This plugin is not necessary to use Storybook and the section marked `// optional` can be safely removed if the features of TSDocgen are not required. The above example shows a working Webpack config with the [TSDocgen plugin](https://github.com/strothj/react-docgen-typescript-loader) integrated. This plugin is not necessary to use Storybook and the section marked `// optional` can be safely removed if the features of TSDocgen are not required.
### `tsconfig.json` ### `tsconfig.json`
@ -100,8 +100,8 @@ module.exports = ({ config, mode }) => {
test: /\.(ts|tsx)$/, test: /\.(ts|tsx)$/,
loader: require.resolve('babel-loader'), loader: require.resolve('babel-loader'),
options: { options: {
presets: [['react-app', { flow: false, typescript: true }]] presets: [['react-app', { flow: false, typescript: true }]],
} },
}); });
config.resolve.extensions.push('.ts', '.tsx'); config.resolve.extensions.push('.ts', '.tsx');
return config; return config;
@ -154,8 +154,8 @@ Please refer to the [react-docgen-typescript-loader](https://github.com/strothj/
Additional annotation can be achieved by setting a default set of info parameters: Additional annotation can be achieved by setting a default set of info parameters:
```ts ```ts
import {addDecorator} from "@storybook/react"; import { addDecorator } from '@storybook/react';
import {withInfo} from "@storybook/addon-info"; import { withInfo } from '@storybook/addon-info';
// Globally in your .storybook/config.js, or alternatively, per-chapter // Globally in your .storybook/config.js, or alternatively, per-chapter
addDecorator( addDecorator(