Skip to content

Commit

Permalink
Merge pull request #28271 from ahayes91/docs-build-storybook-references
Browse files Browse the repository at this point in the history
Docs: Update build Storybook references
  • Loading branch information
jonniebigodes authored Jul 24, 2024
2 parents 779f0a5 + f2b5884 commit 17e26a7
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion code/addons/docs/docs/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ The Storybook UI is a workshop for developing components in isolation. Storybook
To address this, we’ve added a CLI flag to only export the docs. This flag is also available in dev mode:

```sh
yarn build-storybook --docs
yarn storybook build --docs
```

## Disabling docs stories
Expand Down
4 changes: 2 additions & 2 deletions code/core/src/core-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ It contains:

- CLI arg parsing
- Storybook UI "manager" webpack configuration
- `start-storybook` dev server
- `build-storybook` static builder
- `storybook dev` dev server
- `storybook build` static builder
- presets handling

The "preview" (aka iframe) side is implemented in pluggable builders:
Expand Down
4 changes: 3 additions & 1 deletion docs/api/main-config/main-config-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Type: `TestBuildFlags`
Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `build-storybook`, this feature is enabled by setting the `--test` [flag](../cli-options.mdx#build).

<Callout variant="info" icon="💡">
The options documented on this page are automatically enabled when the `--test` flag is provided to the `build-storybook` command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.

The options documented on this page are automatically enabled when the `--test` flag is provided to the [`storybook build`](../cli-options.mdx#build) command. We encourage you to override these options only if you need to disable a specific feature for your project or if you are debugging a build issue.

</Callout>

### `test.disableBlocks`
Expand Down
2 changes: 1 addition & 1 deletion docs/writing-docs/build-documentation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There's some caveats to this build mode, as to the normal Storybook build:

## Publish Storybook's documentation

You can also publish your documentation, the same you would [publish](../sharing/publish-storybook.mdx) your Storybook. You can use the `--docs` flag with `build-storybook` command. We recommend as well including it as a script in your `package.json` file:
You can also publish your documentation the same you would [publish](../sharing/publish-storybook.mdx) your Storybook. You can use the `--docs` flag with the [`storybook build`](../api/cli-options.mdx#build) command. We recommend as well including it as a script in your `package.json` file:

```json
{
Expand Down

0 comments on commit 17e26a7

Please sign in to comment.