publish-storybook.md

title
Publish Storybook

Teams publish Storybook online to review and collaborate on works in progress. That allows developers, designers, PMs, and other stakeholders to check if the UI looks right without touching code or requiring a local dev environment.

Build Storybook as a static web application

First, we'll need to build Storybook as a static web application. The functionality is already built-in and pre-configured for most supported frameworks. Others require a bit of customization (e.g., Angular). Run the following command inside your project's root directory:

<CodeSnippets paths={[ 'angular/custom-build-script-production.script-for-builder.js.mdx', 'angular/build-storybook-production-mode.with-builder.js.mdx', 'common/build-storybook-production-mode.yarn.js.mdx', 'common/build-storybook-production-mode.npm.js.mdx', 'common/build-storybook-production-mode.pnpm.js.mdx', ]} />

💡 You can provide additional flags to customize the command. Read more about the flag options here.

Storybook will create a static web application capable of being served by any web server. Preview it locally by running the following command:

<CodeSnippets paths={[ 'common/preview-storybook-production-mode.npm.js.mdx', 'common/preview-storybook-production-mode.pnpm.js.mdx', ]} />

Publish Storybook with Chromatic

Once you've built your Storybook as a static web application, you can publish it to your web host. We recommend Chromatic, a free publishing service made for Storybook that documents, versions, and indexes your UI components securely in the cloud.

To get started, sign up with your GitHub, GitLab, Bitbucket, or email and generate a unique project-token for your project.

Next, install the Chromatic CLI package from npm:

<CodeSnippets paths={[ 'common/chromatic-install.yarn.js.mdx', 'common/chromatic-install.npm.js.mdx', ]} />

Run the following command after the package finishes installing. Make sure that you replace your-project-token with your own project token.

npx chromatic --project-token=<your-project-token>

When Chromatic finishes, you should have successfully deployed your Storybook. Preview it by clicking the link provided (i.e., https://random-uuid.chromatic.com).

Build 1 published.

View it online at https://www.chromatic.com/build?appId=...&number=1.

Setup CI to publish automatically

Configure your CI environment to publish your Storybook and run Chromatic) whenever you push code to a repository. Let's see how to set it up using GitHub Actions.

In your project's root directory, add a new file called chromatic.yml inside the .github/workflows directory:

<CodeSnippets paths={[ 'common/chromatic-github-action.js.mdx', ]} />

💡 Secrets are secure environment variables provided by GitHub so that you don't need to hard code your project-token. Read the official documentation to learn how to configure them.

Commit and push the file. Congratulations, you've successfully automated publishing your Storybook. Now whenever you open a PR you’ll get a handy link to your published Storybook in your PR checks.

Review with your team

Publishing Storybook as part of the development process makes it quick and easy to gather team feedback.

A common method to ask for review is to paste a link to the published Storybook in a pull request or Slack.

If you publish your Storybook to Chromatic, you can use the UI Review feature to automatically scan your PRs for new and updated stories. That makes it easy to identify what changed and give feedback.

Versioning and history

When you publish Storybook, you also get component history and versioning down to the commit. That's useful during implementation review for comparing components between branches/commits to past versions.

Publish Storybook to other services

Since Storybook is built as a static web application, you can also publish it to any web host, including GitHub Pages, Netlify, AWS S3, and more. However, features such as Composition, embedding stories, history, and versioning require tighter integration with Storybook APIs and secure authentication. Your hosting provider may not be capable of supporting these features. Learn about the Component Publishing Protocol (CPP) to see what.

ℹ️ Additional header configuration may be required to serve Storybook's static files correctly on your host. For more information on the required headers, see the Migration guide.

Component Publishing Protocol (CPP)

Storybook can communicate with services that host built Storybooks online. This enables features such as Composition. We categorize services via compliance with the "Component Publishing Protocol" (CPP) with various levels of support in Storybook.

CPP level 1

This level of service serves published Storybooks and makes the following available:

• Versioned endpoints, URLs that resolve to different published Storybooks depending on a version=x.y.z query parameter (where x.y.z is the released version of the package).
• Support for /stories.json
• Support for /metadata.json and the releases field.

Example: Chromatic

CPP level 0

This level of service can serve published Storybooks but has no further integration with Storybook’s APIs.

Examples: Netlify, S3

Search engine optimization (SEO)

If your Storybook is publically viewable, you may wish to configure how it is represented in search engine result pages.

Description

You can provide a description for search engines to display in the results listing, by adding the following to the manager-head.html file in your config directory:

<CodeSnippets paths={[ 'common/seo-description.html.mdx', ]} />

Preventing your Storybook from being crawled

You can prevent your published Storybook from appearing in search engine results by including a noindex meta tag, which you can do by adding the following to the manager-head.html file in your config directory:

<CodeSnippets paths={[ 'common/seo-noindex.html.mdx', ]} />