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 {