Storybook Docs

docs

Parent: main.js|ts configuration

Type:

{
  autodocs?: boolean | 'tag';
  defaultName?: string;
  docsMode?: boolean;
}

Configures Storybook's auto-generated documentation.

autodocs

Type: boolean | 'tag'

Default: 'tag'

Enables or disables automatic documentation for stories.

  • true: Enables it for all stories
  • false: Disables it for all stories
  • 'tag': Enables it for stories tagged with 'autodocs'
Code Snippets
Oh no! We could not find the code you are looking for.
It would be great if you could report an issue on Github if you see that message.

defaultName

Type: string

Default: 'Docs'

Name used for generated documentation pages.

Code Snippets
Oh no! We could not find the code you are looking for.
It would be great if you could report an issue on Github if you see that message.

docsMode

Type: boolean

Only show documentation pages in the sidebar (usually set with the --docs CLI flag).

Code Snippets
Oh no! We could not find the code you are looking for.
It would be great if you could report an issue on Github if you see that message.
Join the community

6,378 developers and counting
Open source software
Maintained by
Chromatic
Special thanks to Netlify and CircleCi