@storybook/addon-docs

What is @storybook/addon-docs?

The @storybook/addon-docs package is a Storybook addon that allows developers to write documentation alongside their stories. It uses MDX (Markdown with JSX) to let you document components in a rich, interactive way. It can generate documentation automatically based on your stories and supports a wide range of component frameworks.

What are @storybook/addon-docs's main functionalities?

MDX Documentation

Allows writing documentation using MDX, which can include both Markdown and JSX. You can define metadata, write narrative documentation, and showcase live examples and prop tables.

import { Meta, Story, ArgsTable, Canvas } from '@storybook/addon-docs/blocks';

<Meta title='MyComponent' />

# MyComponent

This is a **custom documentation** for `MyComponent`.

<Canvas>
  <Story name='Basic' args={{ label: 'Hello World' }}>
    {args => <MyComponent {...args} />}
  </Story>
</Canvas>

<ArgsTable story='Basic' />

Automatic Props Table

Generates a table of the component's props automatically. This table includes the prop names, types, default values, and descriptions if they are specified in the component's propTypes or TypeScript definitions.

import { Meta, Story, ArgsTable } from '@storybook/addon-docs/blocks';

<Meta title='MyComponent' />

<Story name='Basic'>
  <MyComponent />
</Story>

<ArgsTable of={MyComponent} />

Embedding Stories

Allows embedding live Storybook stories within the documentation. This provides an interactive example of the component in use.

import { Meta, Story } from '@storybook/addon-docs/blocks';

<Meta title='MyComponent' />

<Story name='Basic'>
  <MyComponent />
</Story>

Other packages similar to @storybook/addon-docs

react-styleguidist

React Styleguidist is a component development environment with a living style guide. It allows developers to document components with Markdown and showcase usage examples. It differs from @storybook/addon-docs in that it is a standalone tool rather than an addon to Storybook, and it focuses more on the style guide aspect.

docz

Docz leverages MDX to allow developers to write documentation and demos for their components. It is similar to @storybook/addon-docs in its use of MDX, but it is a standalone documentation tool that provides its own UI and does not require Storybook.

docusaurus

Docusaurus is a static site generator that can be used to create documentation websites. It supports Markdown and MDX and can be used to document React components, but it is not specifically tied to component stories like @storybook/addon-docs. It is more general-purpose and can be used for a wide range of documentation needs.

README

The README file is missing