From febc8c22e338f3d93d0c502d8409da044a583634 Mon Sep 17 00:00:00 2001 From: Aislinn Hayes Date: Tue, 18 Jun 2024 16:44:47 +0100 Subject: [PATCH 1/4] update a bunch of references to `build-storybook` command in the docs to `storybook build` --- code/addons/docs/docs/recipes.md | 34 +++++++++---------- code/lib/core-server/README.md | 4 +-- docs/api/main-config-build.md | 4 +-- docs/configure/environment-variables.md | 2 +- ...build-storybook-production-mode.npm.js.mdx | 2 +- ...uild-storybook-production-mode.pnpm.js.mdx | 2 +- ...uild-storybook-production-mode.yarn.js.mdx | 2 +- .../snippets/common/ghp-github-action.yml.mdx | 2 +- .../storybook-build-test-flag.npm.js.mdx | 2 +- .../storybook-build-test-flag.pnpm.js.mdx | 2 +- .../storybook-build-test-flag.yarn.js.mdx | 2 +- .../storybook-debug-webpack-prod.npm.js.mdx | 2 +- .../storybook-debug-webpack-prod.yarn.js.mdx | 2 +- .../test-runner-local-build-workflow.yml.mdx | 2 +- docs/writing-docs/build-documentation.md | 2 +- 15 files changed, 33 insertions(+), 33 deletions(-) diff --git a/code/addons/docs/docs/recipes.md b/code/addons/docs/docs/recipes.md index e98c89145b78..bbc6152064e1 100644 --- a/code/addons/docs/docs/recipes.md +++ b/code/addons/docs/docs/recipes.md @@ -2,22 +2,22 @@ [Storybook Docs](../README.md) consists of two basic mechanisms, [DocsPage](docspage.md) and [MDX](mdx.md). But how should you use them in your project? -- [Component Story Format (CSF) with DocsPage](#component-story-format-csf-with-docspage) -- [Pure MDX Stories](#pure-mdx-stories) -- [CSF Stories with MDX Docs](#csf-stories-with-mdx-docs) -- [CSF Stories with arbitrary MDX](#csf-stories-with-arbitrary-mdx) -- [Mixing storiesOf with CSF/MDX](#mixing-storiesof-with-csfmdx) -- [Migrating from notes/info addons](#migrating-from-notesinfo-addons) -- [Exporting documentation](#exporting-documentation) -- [Disabling docs stories](#disabling-docs-stories) - - [DocsPage](#docspage) - - [MDX Stories](#mdx-stories) -- [Controlling a story's view mode](#controlling-a-storys-view-mode) -- [Reordering Docs tab first](#reordering-docs-tab-first) -- [Customizing source snippets](#customizing-source-snippets) -- [Overwriting docs container](#overwriting-docs-container) -- [Add description to individual stories](#add-description-to-individual-stories) -- [More resources](#more-resources) +1. [Component Story Format (CSF) with DocsPage](#component-story-format-csf-with-docspage) +2. [Pure MDX Stories](#pure-mdx-stories) +3. [CSF Stories with MDX Docs](#csf-stories-with-mdx-docs) +4. [CSF Stories with arbitrary MDX](#csf-stories-with-arbitrary-mdx) +5. [Mixing storiesOf with CSF/MDX](#mixing-storiesof-with-csfmdx) +6. [Migrating from notes/info addons](#migrating-from-notesinfo-addons) +7. [Exporting documentation](#exporting-documentation) +8. [Disabling docs stories](#disabling-docs-stories) + 1. [DocsPage](#docspage) + 2. [MDX Stories](#mdx-stories) +9. [Controlling a story's view mode](#controlling-a-storys-view-mode) +10. [Reordering Docs tab first](#reordering-docs-tab-first) +11. [Customizing source snippets](#customizing-source-snippets) +12. [Overwriting docs container](#overwriting-docs-container) +13. [Add description to individual stories](#add-description-to-individual-stories) +14. [More resources](#more-resources) ## Component Story Format (CSF) with DocsPage @@ -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 diff --git a/code/lib/core-server/README.md b/code/lib/core-server/README.md index 4af52cb89409..3dcc1dfcbac2 100644 --- a/code/lib/core-server/README.md +++ b/code/lib/core-server/README.md @@ -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: diff --git a/docs/api/main-config-build.md b/docs/api/main-config-build.md index e9c4c5adc001..f155036d5ea6 100644 --- a/docs/api/main-config-build.md +++ b/docs/api/main-config-build.md @@ -25,11 +25,11 @@ 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.md#build). +Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `storybook build`, this feature is enabled by setting the `--test` [flag](./cli-options.md#build). -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` 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. diff --git a/docs/configure/environment-variables.md b/docs/configure/environment-variables.md index e2948c3027b6..f5fb25880189 100644 --- a/docs/configure/environment-variables.md +++ b/docs/configure/environment-variables.md @@ -105,7 +105,7 @@ You can also use specific files for specific modes. Add a `.env.development` or -You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.md) with `build-storybook`. +You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.md) with `storybook build`. Then they'll be hardcoded to the static version of your Storybook. diff --git a/docs/snippets/common/build-storybook-production-mode.npm.js.mdx b/docs/snippets/common/build-storybook-production-mode.npm.js.mdx index 9c9772fa2f98..d0cdf14959b1 100644 --- a/docs/snippets/common/build-storybook-production-mode.npm.js.mdx +++ b/docs/snippets/common/build-storybook-production-mode.npm.js.mdx @@ -1,3 +1,3 @@ ```shell -npm run build-storybook +npm run storybook build ``` diff --git a/docs/snippets/common/build-storybook-production-mode.pnpm.js.mdx b/docs/snippets/common/build-storybook-production-mode.pnpm.js.mdx index bb0d791674f1..44ecc358f8c6 100644 --- a/docs/snippets/common/build-storybook-production-mode.pnpm.js.mdx +++ b/docs/snippets/common/build-storybook-production-mode.pnpm.js.mdx @@ -1,3 +1,3 @@ ```shell -pnpm run build-storybook +pnpm run storybook build ``` diff --git a/docs/snippets/common/build-storybook-production-mode.yarn.js.mdx b/docs/snippets/common/build-storybook-production-mode.yarn.js.mdx index 98584cdeee79..50db01f50eda 100644 --- a/docs/snippets/common/build-storybook-production-mode.yarn.js.mdx +++ b/docs/snippets/common/build-storybook-production-mode.yarn.js.mdx @@ -1,3 +1,3 @@ ```shell -yarn build-storybook +yarn storybook build ``` diff --git a/docs/snippets/common/ghp-github-action.yml.mdx b/docs/snippets/common/ghp-github-action.yml.mdx index 6efff5954e66..f3670fec0330 100644 --- a/docs/snippets/common/ghp-github-action.yml.mdx +++ b/docs/snippets/common/ghp-github-action.yml.mdx @@ -33,7 +33,7 @@ jobs: - uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3 with: install_command: yarn install # default: npm ci - build_command: yarn build-storybook # default: npm run build-storybook + build_command: yarn storybook build # default: npm run storybook build path: storybook-static # default: dist/storybook checkout: false # default: true ``` diff --git a/docs/snippets/common/storybook-build-test-flag.npm.js.mdx b/docs/snippets/common/storybook-build-test-flag.npm.js.mdx index 202b2cdb3188..d3db30a92837 100644 --- a/docs/snippets/common/storybook-build-test-flag.npm.js.mdx +++ b/docs/snippets/common/storybook-build-test-flag.npm.js.mdx @@ -1,3 +1,3 @@ ```shell -npm run build-storybook -- --test +npm run storybook build -- --test ``` diff --git a/docs/snippets/common/storybook-build-test-flag.pnpm.js.mdx b/docs/snippets/common/storybook-build-test-flag.pnpm.js.mdx index ae1a481577d1..80be3ed545e2 100644 --- a/docs/snippets/common/storybook-build-test-flag.pnpm.js.mdx +++ b/docs/snippets/common/storybook-build-test-flag.pnpm.js.mdx @@ -1,3 +1,3 @@ ```shell -pnpm run build-storybook --test +pnpm run storybook build --test ``` diff --git a/docs/snippets/common/storybook-build-test-flag.yarn.js.mdx b/docs/snippets/common/storybook-build-test-flag.yarn.js.mdx index cb2007d3e8b8..bb320e57645e 100644 --- a/docs/snippets/common/storybook-build-test-flag.yarn.js.mdx +++ b/docs/snippets/common/storybook-build-test-flag.yarn.js.mdx @@ -1,3 +1,3 @@ ```shell -yarn build-storybook --test +yarn storybook build --test ``` diff --git a/docs/snippets/common/storybook-debug-webpack-prod.npm.js.mdx b/docs/snippets/common/storybook-debug-webpack-prod.npm.js.mdx index 7ff32dc52425..b64b8d99794f 100644 --- a/docs/snippets/common/storybook-debug-webpack-prod.npm.js.mdx +++ b/docs/snippets/common/storybook-debug-webpack-prod.npm.js.mdx @@ -1,3 +1,3 @@ ```shell -npm run build-storybook -- --debug-webpack +npm run storybook build -- --debug-webpack ``` diff --git a/docs/snippets/common/storybook-debug-webpack-prod.yarn.js.mdx b/docs/snippets/common/storybook-debug-webpack-prod.yarn.js.mdx index a54aff6dd9aa..a339f5ae7fab 100644 --- a/docs/snippets/common/storybook-debug-webpack-prod.yarn.js.mdx +++ b/docs/snippets/common/storybook-debug-webpack-prod.yarn.js.mdx @@ -1,3 +1,3 @@ ```shell -yarn build-storybook --debug-webpack +yarn storybook build --debug-webpack ``` diff --git a/docs/snippets/common/test-runner-local-build-workflow.yml.mdx b/docs/snippets/common/test-runner-local-build-workflow.yml.mdx index 0d066c05c066..44de3bef246a 100644 --- a/docs/snippets/common/test-runner-local-build-workflow.yml.mdx +++ b/docs/snippets/common/test-runner-local-build-workflow.yml.mdx @@ -17,7 +17,7 @@ jobs: - name: Install Playwright run: npx playwright install --with-deps - name: Build Storybook - run: yarn build-storybook --quiet + run: yarn storybook build --quiet - name: Serve Storybook and run tests run: | npx concurrently -k -s first -n "SB,TEST" -c "magenta,blue" \ diff --git a/docs/writing-docs/build-documentation.md b/docs/writing-docs/build-documentation.md index aeaec7bf5ae9..4cd87a5ca498 100644 --- a/docs/writing-docs/build-documentation.md +++ b/docs/writing-docs/build-documentation.md @@ -30,7 +30,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.md) 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.md) your Storybook. You can use the `--docs` flag with `storybook build` command. We recommend as well including it as a script in your `package.json` file: ```json { From 26c839e280a25c82a17aad7b7a5dbdf09371f0be Mon Sep 17 00:00:00 2001 From: Aislinn Hayes Date: Tue, 18 Jun 2024 16:53:32 +0100 Subject: [PATCH 2/4] undo some auto-formatting from my IDE --- code/addons/docs/docs/recipes.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/code/addons/docs/docs/recipes.md b/code/addons/docs/docs/recipes.md index bbc6152064e1..0a982974f390 100644 --- a/code/addons/docs/docs/recipes.md +++ b/code/addons/docs/docs/recipes.md @@ -2,22 +2,22 @@ [Storybook Docs](../README.md) consists of two basic mechanisms, [DocsPage](docspage.md) and [MDX](mdx.md). But how should you use them in your project? -1. [Component Story Format (CSF) with DocsPage](#component-story-format-csf-with-docspage) -2. [Pure MDX Stories](#pure-mdx-stories) -3. [CSF Stories with MDX Docs](#csf-stories-with-mdx-docs) -4. [CSF Stories with arbitrary MDX](#csf-stories-with-arbitrary-mdx) -5. [Mixing storiesOf with CSF/MDX](#mixing-storiesof-with-csfmdx) -6. [Migrating from notes/info addons](#migrating-from-notesinfo-addons) -7. [Exporting documentation](#exporting-documentation) -8. [Disabling docs stories](#disabling-docs-stories) - 1. [DocsPage](#docspage) - 2. [MDX Stories](#mdx-stories) -9. [Controlling a story's view mode](#controlling-a-storys-view-mode) -10. [Reordering Docs tab first](#reordering-docs-tab-first) -11. [Customizing source snippets](#customizing-source-snippets) -12. [Overwriting docs container](#overwriting-docs-container) -13. [Add description to individual stories](#add-description-to-individual-stories) -14. [More resources](#more-resources) +- [Component Story Format (CSF) with DocsPage](#component-story-format-csf-with-docspage) +- [Pure MDX Stories](#pure-mdx-stories) +- [CSF Stories with MDX Docs](#csf-stories-with-mdx-docs) +- [CSF Stories with arbitrary MDX](#csf-stories-with-arbitrary-mdx) +- [Mixing storiesOf with CSF/MDX](#mixing-storiesof-with-csfmdx) +- [Migrating from notes/info addons](#migrating-from-notesinfo-addons) +- [Exporting documentation](#exporting-documentation) +- [Disabling docs stories](#disabling-docs-stories) + - [DocsPage](#docspage) + - [MDX Stories](#mdx-stories) +- [Controlling a story's view mode](#controlling-a-storys-view-mode) +- [Reordering Docs tab first](#reordering-docs-tab-first) +- [Customizing source snippets](#customizing-source-snippets) +- [Overwriting docs container](#overwriting-docs-container) +- [Add description to individual stories](#add-description-to-individual-stories) +- [More resources](#more-resources) ## Component Story Format (CSF) with DocsPage From 53206cad887c3f2d341606fd96b8a4f20f14aed5 Mon Sep 17 00:00:00 2001 From: Aislinn Hayes Date: Mon, 1 Jul 2024 12:11:49 +0100 Subject: [PATCH 3/4] update the references again after merging latest next branch --- docs/_snippets/build-storybook-production-mode.md | 6 +++--- docs/_snippets/storybook-build-test-flag.md | 6 +++--- docs/_snippets/storybook-debug-webpack-prod.md | 4 ++-- docs/api/main-config/main-config-build.mdx | 4 ++-- docs/configure/environment-variables.mdx | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/_snippets/build-storybook-production-mode.md b/docs/_snippets/build-storybook-production-mode.md index 27b75f36ca31..8c48e2926699 100644 --- a/docs/_snippets/build-storybook-production-mode.md +++ b/docs/_snippets/build-storybook-production-mode.md @@ -6,14 +6,14 @@ ng run my-project:build-storybook ``` ```shell renderer="common" language="js" packageManager="npm" -npm run build-storybook +npm run storybook build ``` ```shell renderer="common" language="js" packageManager="pnpm" -pnpm run build-storybook +pnpm run storybook build ``` ```shell renderer="common" language="js" packageManager="yarn" -yarn build-storybook +yarn storybook build ``` diff --git a/docs/_snippets/storybook-build-test-flag.md b/docs/_snippets/storybook-build-test-flag.md index 52eaf29d1762..7e2ee34d498b 100644 --- a/docs/_snippets/storybook-build-test-flag.md +++ b/docs/_snippets/storybook-build-test-flag.md @@ -1,12 +1,12 @@ ```shell renderer="common" language="js" packageManager="npm" -npm run build-storybook -- --test +npm run storybook build -- --test ``` ```shell renderer="common" language="js" packageManager="pnpm" -pnpm run build-storybook --test +pnpm run storybook build --test ``` ```shell renderer="common" language="js" packageManager="yarn" -yarn build-storybook --test +yarn storybook build --test ``` diff --git a/docs/_snippets/storybook-debug-webpack-prod.md b/docs/_snippets/storybook-debug-webpack-prod.md index 4c181925d55c..3f40191b56a4 100644 --- a/docs/_snippets/storybook-debug-webpack-prod.md +++ b/docs/_snippets/storybook-debug-webpack-prod.md @@ -1,8 +1,8 @@ ```shell renderer="common" language="js" packageManager="npm" -npm run build-storybook -- --debug-webpack +npm run storybook build -- --debug-webpack ``` ```shell renderer="common" language="js" packageManager="yarn" -yarn build-storybook --debug-webpack +yarn storybook build --debug-webpack ``` diff --git a/docs/api/main-config/main-config-build.mdx b/docs/api/main-config/main-config-build.mdx index 73d56d975273..46bd0e295a6e 100644 --- a/docs/api/main-config/main-config-build.mdx +++ b/docs/api/main-config/main-config-build.mdx @@ -28,10 +28,10 @@ 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). +Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `storybook build`, this feature is enabled by setting the `--test` [flag](../cli-options.mdx#build). - 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` 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. ### `test.disableBlocks` diff --git a/docs/configure/environment-variables.mdx b/docs/configure/environment-variables.mdx index 1403cc371c69..9bab683b2aac 100644 --- a/docs/configure/environment-variables.mdx +++ b/docs/configure/environment-variables.mdx @@ -72,7 +72,7 @@ Then you can access this environment variable anywhere, even within your stories You can also use specific files for specific modes. Add a `.env.development` or `.env.production` to apply different values to your environment variables. -You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `build-storybook`. +You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `storybook build`. Then they'll be hardcoded to the static version of your Storybook. From f2b588495eaeb057c6640c14aea449142f643f85 Mon Sep 17 00:00:00 2001 From: Aislinn Hayes Date: Wed, 24 Jul 2024 14:27:13 +0100 Subject: [PATCH 4/4] make suggested changes from PR --- docs/_snippets/build-storybook-production-mode.md | 6 +++--- docs/_snippets/ghp-github-action.md | 2 +- docs/_snippets/storybook-build-test-flag.md | 6 +++--- docs/_snippets/storybook-debug-webpack-prod.md | 4 ++-- docs/_snippets/test-runner-local-build-workflow.md | 2 +- docs/api/main-config/main-config-build.mdx | 6 ++++-- docs/configure/environment-variables.mdx | 2 +- docs/writing-docs/build-documentation.mdx | 2 +- 8 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/_snippets/build-storybook-production-mode.md b/docs/_snippets/build-storybook-production-mode.md index 8c48e2926699..27b75f36ca31 100644 --- a/docs/_snippets/build-storybook-production-mode.md +++ b/docs/_snippets/build-storybook-production-mode.md @@ -6,14 +6,14 @@ ng run my-project:build-storybook ``` ```shell renderer="common" language="js" packageManager="npm" -npm run storybook build +npm run build-storybook ``` ```shell renderer="common" language="js" packageManager="pnpm" -pnpm run storybook build +pnpm run build-storybook ``` ```shell renderer="common" language="js" packageManager="yarn" -yarn storybook build +yarn build-storybook ``` diff --git a/docs/_snippets/ghp-github-action.md b/docs/_snippets/ghp-github-action.md index 2be756acbc4b..1d02c60a0827 100644 --- a/docs/_snippets/ghp-github-action.md +++ b/docs/_snippets/ghp-github-action.md @@ -33,7 +33,7 @@ jobs: - uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3 with: install_command: yarn install # default: npm ci - build_command: yarn storybook build # default: npm run storybook build + build_command: yarn build-storybook # default: npm run build-storybook path: storybook-static # default: dist/storybook checkout: false # default: true ``` diff --git a/docs/_snippets/storybook-build-test-flag.md b/docs/_snippets/storybook-build-test-flag.md index 7e2ee34d498b..52eaf29d1762 100644 --- a/docs/_snippets/storybook-build-test-flag.md +++ b/docs/_snippets/storybook-build-test-flag.md @@ -1,12 +1,12 @@ ```shell renderer="common" language="js" packageManager="npm" -npm run storybook build -- --test +npm run build-storybook -- --test ``` ```shell renderer="common" language="js" packageManager="pnpm" -pnpm run storybook build --test +pnpm run build-storybook --test ``` ```shell renderer="common" language="js" packageManager="yarn" -yarn storybook build --test +yarn build-storybook --test ``` diff --git a/docs/_snippets/storybook-debug-webpack-prod.md b/docs/_snippets/storybook-debug-webpack-prod.md index 3f40191b56a4..4c181925d55c 100644 --- a/docs/_snippets/storybook-debug-webpack-prod.md +++ b/docs/_snippets/storybook-debug-webpack-prod.md @@ -1,8 +1,8 @@ ```shell renderer="common" language="js" packageManager="npm" -npm run storybook build -- --debug-webpack +npm run build-storybook -- --debug-webpack ``` ```shell renderer="common" language="js" packageManager="yarn" -yarn storybook build --debug-webpack +yarn build-storybook --debug-webpack ``` diff --git a/docs/_snippets/test-runner-local-build-workflow.md b/docs/_snippets/test-runner-local-build-workflow.md index a227d2cf76dd..b429c34cfaeb 100644 --- a/docs/_snippets/test-runner-local-build-workflow.md +++ b/docs/_snippets/test-runner-local-build-workflow.md @@ -17,7 +17,7 @@ jobs: - name: Install Playwright run: npx playwright install --with-deps - name: Build Storybook - run: yarn storybook build --quiet + run: yarn build-storybook --quiet - name: Serve Storybook and run tests run: | npx concurrently -k -s first -n "SB,TEST" -c "magenta,blue" \ diff --git a/docs/api/main-config/main-config-build.mdx b/docs/api/main-config/main-config-build.mdx index 46bd0e295a6e..d488fd06b0aa 100644 --- a/docs/api/main-config/main-config-build.mdx +++ b/docs/api/main-config/main-config-build.mdx @@ -28,10 +28,12 @@ Type: `TestBuildFlags` } ``` -Configures Storybook's production builds for performance testing purposes by disabling certain features from the build. When running `storybook build`, this feature is enabled by setting the `--test` [flag](../cli-options.mdx#build). +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). - The options documented on this page are automatically enabled when the `--test` flag is provided to the `storybook 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. + + 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. + ### `test.disableBlocks` diff --git a/docs/configure/environment-variables.mdx b/docs/configure/environment-variables.mdx index 9bab683b2aac..1403cc371c69 100644 --- a/docs/configure/environment-variables.mdx +++ b/docs/configure/environment-variables.mdx @@ -72,7 +72,7 @@ Then you can access this environment variable anywhere, even within your stories You can also use specific files for specific modes. Add a `.env.development` or `.env.production` to apply different values to your environment variables. -You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `storybook build`. +You can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `build-storybook`. Then they'll be hardcoded to the static version of your Storybook. diff --git a/docs/writing-docs/build-documentation.mdx b/docs/writing-docs/build-documentation.mdx index f4d08d22187c..19f052996a4d 100644 --- a/docs/writing-docs/build-documentation.mdx +++ b/docs/writing-docs/build-documentation.mdx @@ -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 `storybook build` 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 {