@nrwl/storybook:storybook

Serve up storybook in development mode.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Examples

These buttons show the config object for specific common tasks.

Options

config

Required

config

.storybook configuration.

docsMode

boolean

Default: false

Build a documentation-only site using addon-docs.

host

string

Default: localhost

Host to listen on.

https

boolean

Default: false

Serve using HTTPS.

port

number

Default: 9009

Port to listen on.

projectBuildConfig

string

Workspace project where Storybook reads the Webpack config from.

quiet

boolean

Default: true

Suppress verbose build output.

sslKey

string

SSL key to use for serving HTTPS.

sslCert

string

SSL certificate to use for serving HTTPS.

staticDir

Deprecated

Array<string>

Directory where to load static files from, array of strings.

In Storybook 6.4 the --static-dir CLI flag has been replaced with the the staticDirs field in .storybook/main.js. It will be removed completely in Storybook 7.0.

styles

Array<oneOf [object , string]>

Global styles to be included in the build. This is for Angular projects only. It will be ignored in non-Angular projects.

stylePreprocessorOptions

Options to pass to style preprocessors.

uiFramework

RequiredHidden

string

Default: @storybook/angular

Accepted values: @storybook/angular, @storybook/react, @storybook/html, @storybook/web-components, @storybook/vue, @storybook/vue3, @storybook/svelte

Storybook framework npm package.

watch

boolean

Default: true

Watches for changes and rebuilds application.