From bf56a6df9b5796d6c18f7ae30099dc0fddd4c409 Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Thu, 5 Mar 2020 05:33:16 +0800 Subject: [PATCH] Merge pull request #10053 from storybookjs/addon-docs-manual-setup Addon-docs: Update manual setup docs --- addons/docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/addons/docs/README.md b/addons/docs/README.md index 1276d5f2c299..0247c1536c1a 100644 --- a/addons/docs/README.md +++ b/addons/docs/README.md @@ -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';