New
Component Story Format 3 is hereAutomate with Chromatic
Storybook Day 2023
Star76,604

Beta
You're viewing pre-release docs for version 7.0. View latest docs

Docs

Documentation is an essential part of modern UI development, as it serves as a reference for developers who may need to understand or integrate your components into their own projects. Well-written documentation can help to promote the project and make it more accessible to a broader audience. Overall, the importance of writing documentation cannot be overstated, as it is a key factor in the success of any project.

In Storybook, this workflow happens automatically. When you write stories for your components, you create living, interactive, sustainable documentation.

How does documentation work in Storybook?

You start by writing a story for your component to define the different states it can be in. Then generate the baseline documentation for your story via tags. Finally, customize the documentation with MDX or optionally with Storybook's Doc Blocks to fully control how the content gets rendered.

Setup automated documentation

To enable auto-generated documentation for your stories, you'll need to add the tags configuration property to the story's default export. For example:

Once the story loads, Storybook infers the relevant metadata (e.g., args, argTypes, parameters) and automatically generates a documentation page with this information positioned at the root-level of your component tree in the sidebar.

Configure

By default, Storybook offers zero-config support for documentation and automatically sets up a documentation page for each story enabled via the tags configuration property. However, you can extend your Storybook configuration file (i.e., .storybook/main.js|ts|cjs) and provide additional options to control how documentation gets created. Listed below are the available options and examples of how to use them.

OptionDescription
disableToggles support for all documentation pages
docs: { disable:true }
autodocsDisables auto-generated documentation pages created via tags
docs: { autodocs: false }
trueEnables auto-generated documentation pages for every component
docs: { autodocs: true }
defaultNameRenames the auto-generated documentation page
docs: { defaultName: 'Documentation' }

Write a custom template

To replace the default documentation template used by Storybook, you can create your own template written in MDX and update your UI configuration file (i.e., .storybook/preview.js) to point to it.

💡 If you only need to override the documentation page for a single component, we recommend creating an MDX file and referencing it directly via the <Meta of={} /> Doc Block.

Setup custom documentation

Storybook provides support for MDX 2, an open standard markup language, combining two other ones: Markdown, which is used for formatting text, and JSX, which is used for rendering dynamic elements on a page. To enable custom documentation for your stories with this format, start by updating your Storybook configuration file (i.e., .storybook/main.js|ts|cjs).

Create an MDX file for your component in the same directory as your stories and components to add your custom documentation. We recommend naming the file similar to your component (e.g., Button.mdx) for easy reference.

💡 If you're overriding an existing auto-generated documentation page, you may see a warning in the console. We recommend removing the tags configuration property from your story to avoid this warning.

Once the MDX documentation is loaded, Storybook will render it alongside your component's story overriding any existing documentation enabled via the tags configuration property.

Fully control custom documentation

Documentation can be expensive to maintain and keep up to date when applied to every project component. To help simplify this process, Storybook provides a set of useful UI components (i.e., Doc Blocks) to help cover more advanced cases. If you need additional content, use them to help create your custom documentation.

Working with multiple components

If you need to document multiple components in a single documentation page, you can reference them directly inside your MDX file. Internally, Storybook looks for the story metadata and composes it alongside your existing documentation. For example:

Advanced configuration

Customize the Docs Container

The Docs Container is the component that wraps up the documentation page. It's responsible for rendering the documentation page in Storybook's UI. You can customize it by creating your own component and updating your Storybook UI configuration file (i.e., .storybook/preview.js) to reference it.

Override the default theme

By default, Storybook provides two themes for the UI: light and dark. If you need to customize the theme used by the documentation to match the existing one, you can update your Storybook UI configuration file (i.e., .storybook/preview.js) and apply it.

Working with custom MDX components

Out of the box, Storybook has a set of components that you can use to customize your documentation page. If you're working with a design system or component library and wish to add them to your documentation page, you can override the MDXProvider component inherited from @mdx-js/react with your own.

Learn more about Storybook documentation

  • Docs for creating documentation for your stories
  • MDX for customizing your documentation
  • Publishing docs to automate the process of publishing your documentation
✍️ Edit on GitHub – PRs welcome!
Join the community
5,898 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI