diff --git a/docs/snippets/common/storybook-extract-result.json.mdx b/docs/snippets/common/storybook-extract-result.json.mdx new file mode 100644 index 000000000000..d3edbcaceb4a --- /dev/null +++ b/docs/snippets/common/storybook-extract-result.json.mdx @@ -0,0 +1,38 @@ +```json +{ + "v": 2, + "globalParameters": {}, + "kindParameters": { + "components/myComponent": { + "fileName": 445, + "framework": "react" + }, + "components/myOtherComponent": { + "fileName": 447, + "framework": "react" + } + }, + "stories": { + "components-mycomponent--simple": { + "id": "components-mycomponent--simple", + "name": "Simple", + "kind": "components/myComponent", + "story": "Simple", + "parameters": { + "__id": "components-mycomponent--simple", + "__isArgsStory": true + } + }, + "components-myothercomponent--simple": { + "id": "components-myothercomponent--simple", + "name": "Simple", + "kind": "components/myothercomponent", + "story": "Simple", + "parameters": { + "__id": "components-myothercomponent--simple", + "__isArgsStory": true + } + } + } +} +``` \ No newline at end of file diff --git a/docs/workflows/storybook-composition.md b/docs/workflows/storybook-composition.md index 33ee88d66436..d64be6d8fe79 100644 --- a/docs/workflows/storybook-composition.md +++ b/docs/workflows/storybook-composition.md @@ -37,3 +37,42 @@ You can also compose Storybook that are running locally. For instance, if you ha This composes the React and Angular Storybooks into your current Storybook. When either code base changes, hot-module-reload will work perfectly. That enables you to develop both frameworks in sync. + +### Improve your Storybook composition + +So far we've covered how we can use composition with local or published Storybooks. One thing worth mentioning as your Storybook will grow in time with your own stories, or through composition with other Storybooks, is that you can optimize the deployment process by including the following command in your workflow: + +```shell +npx sb extract +``` + +Using this command will generate a `stories.json` file in the default build directory (`storybook-static`) with information regarding your Storybook. Here's how it might look: + + + + + + + +Once you add a reference to a Storybook deployed using this method, almost immediately you'll see all the stories and other relevant information displayed in the UI. + +If required, you can also add additional arguments to this command. You can use the following to generate the `stories.json` file to a custom directory: + +```shell +npx sb extract my-built-storybook-directory my-other-directory +``` + +Once the command executes it will look for a built Storybook in the `my-built-storybook-directory` and create the file in `my-other-directory`. + +
+ +If you need to use arguments, you'll need to use both of them, or the command will not be executed properly. + +
+ + + \ No newline at end of file