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

Merge pull request #10053 from storybookjs/addon-docs-manual-setup

Browse Source 
Addon-docs: Update manual setup docs
This commit is contained in:
Michael Shilman 2020-03-05 05:33:16 +08:00 committed by Michael Shilman
parent 68c392e3ef
commit bf56a6df9b
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
addons/docs/README.md
View File

@ -164,7 +164,7 @@ The `configureJSX` option is useful when you're writing your docs in MDX and you
## Manual configuration
If you don't want to use the preset, and prefer to configure "the long way" add the following configuration to `.storybook/main.js` (see comments inline for explanation):
We recommend using the preset, which should work out of the box. If you don't want to use the preset, and prefer to configure "the long way" add the following configuration to `.storybook/main.js` (see comments inline for explanation):
```js
const createCompiler = require('@storybook/addon-docs/mdx-compiler-plugin');
@ -208,7 +208,7 @@ module.exports = {
};
```
Finally, you'll need to set up DocsPage in `.storybook/preview.js`:
You'll also need to set up the docs parameter in `.storybook/preview.js`. This includes the `DocsPage` for rendering the page, a container, and various configuration options, such as `extractComponentDescription` for manually extracting a component description:
```js
import { addParameters } from '@storybook/react';