GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-08 05:51:48 +08:00
Code Issues Packages Projects Releases Wiki Activity
storybook/docs/api/main-config-docs.md
Kyle Gach 1d3262ee62 Address comments: 
- Add `babelDefault` and `managerHead` pages
- Fix broken links
- Clarify when some properties are primarily used by addon authors
- Document simplified options for `babel`, `babelDefault`, `viteFinal`, and `webpackFinal`
- Add description for `core.channelOptions`
- Remove the `previewMainTemplate` page
- Document possible shortcomings of some `stories` configurations
- Document limitations of some `typescript` options
2023-05-23 14:15:53 -06:00

1.3 KiB
Raw Blame History

title
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'

<CodeSnippets paths={[ 'common/main-config-docs-autodocs.js.mdx', 'common/main-config-docs-autodocs.ts.mdx', ]} />

defaultName

Type: string

Default: 'Docs'

Name used for generated documentation pages.

<CodeSnippets paths={[ 'common/main-config-docs-default-name.js.mdx', 'common/main-config-docs-default-name.ts.mdx', ]} />

docsMode

Type: boolean

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

<CodeSnippets paths={[ 'common/main-config-docs-docs-mode.js.mdx', 'common/main-config-docs-docs-mode.ts.mdx', ]} />