mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-08 02:31:49 +08:00
77 lines
1.3 KiB
Markdown
77 lines
1.3 KiB
Markdown
---
|
|
title: 'docs'
|
|
---
|
|
|
|
Parent: [main.js|ts configuration](./main-config.md)
|
|
|
|
Type:
|
|
|
|
```ts
|
|
{
|
|
autodocs?: boolean | 'tag';
|
|
defaultName?: string;
|
|
docsMode?: boolean;
|
|
}
|
|
```
|
|
|
|
Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.md).
|
|
|
|
## `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'`
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
<CodeSnippets
|
|
paths={[
|
|
'common/main-config-docs-autodocs.js.mdx',
|
|
'common/main-config-docs-autodocs.ts.mdx',
|
|
]}
|
|
/>
|
|
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## `defaultName`
|
|
|
|
Type: `string`
|
|
|
|
Default: `'Docs'`
|
|
|
|
Name used for generated documentation pages.
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
<CodeSnippets
|
|
paths={[
|
|
'common/main-config-docs-default-name.js.mdx',
|
|
'common/main-config-docs-default-name.ts.mdx',
|
|
]}
|
|
/>
|
|
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## `docsMode`
|
|
|
|
Type: `boolean`
|
|
|
|
Only show documentation pages in the sidebar (usually set with the `--docs` CLI flag).
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
<CodeSnippets
|
|
paths={[
|
|
'common/main-config-docs-docs-mode.js.mdx',
|
|
'common/main-config-docs-docs-mode.ts.mdx',
|
|
]}
|
|
/>
|
|
|
|
<!-- prettier-ignore-end -->
|