diff --git a/docs/_snippets/main-config-docs-autodocs.md b/docs/_snippets/main-config-docs-autodocs.md
deleted file mode 100644
index dbb46507dfc6..000000000000
--- a/docs/_snippets/main-config-docs-autodocs.md
+++ /dev/null
@@ -1,25 +0,0 @@
-```js filename=".storybook/main.js" renderer="common" language="js"
-export default {
- // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
- framework: '@storybook/your-framework',
- stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
- docs: {
- autodocs: 'tag',
- },
-};
-```
-
-```ts filename=".storybook/main.ts" renderer="common" language="ts"
-// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.
-import type { StorybookConfig } from '@storybook/your-framework';
-
-const config: StorybookConfig = {
- framework: '@storybook/your-framework',
- stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
- docs: {
- autodocs: 'tag',
- },
-};
-
-export default config;
-```
diff --git a/docs/_snippets/main-config-typical.md b/docs/_snippets/main-config-typical.md
index 517132267e74..caa1cc076889 100644
--- a/docs/_snippets/main-config-typical.md
+++ b/docs/_snippets/main-config-typical.md
@@ -7,7 +7,7 @@ const config = {
// Optional
addons: ['@storybook/addon-docs'],
docs: {
- autodocs: 'tag',
+ defaultName: 'Documentation',
},
staticDirs: ['../public'],
};
@@ -25,7 +25,7 @@ const config: StorybookConfig = {
// Optional
addons: ['@storybook/addon-docs'],
docs: {
- autodocs: 'tag',
+ defaultName: 'Documentation',
},
staticDirs: ['../public'],
};
diff --git a/docs/_snippets/storybook-auto-docs-full-config.md b/docs/_snippets/storybook-auto-docs-full-config.md
index f6ffa81781c3..37f6dde8a550 100644
--- a/docs/_snippets/storybook-auto-docs-full-config.md
+++ b/docs/_snippets/storybook-auto-docs-full-config.md
@@ -7,6 +7,7 @@ export default {
docs: {
//👇 See the table below for the list of supported options
defaultName: 'Documentation',
+ docsMode: true,
},
};
```
@@ -22,6 +23,7 @@ const config: StorybookConfig = {
docs: {
//👇 See the table below for the list of supported options
defaultName: 'Documentation',
+ docsMode: true,
},
};
diff --git a/docs/api/main-config/main-config-docs.mdx b/docs/api/main-config/main-config-docs.mdx
index b0d7f4a1ae2a..7c28850020ae 100644
--- a/docs/api/main-config/main-config-docs.mdx
+++ b/docs/api/main-config/main-config-docs.mdx
@@ -11,7 +11,6 @@ Type:
```ts
{
- autodocs?: boolean | 'tag';
defaultName?: string;
docsMode?: boolean;
}
@@ -19,24 +18,6 @@ Type:
Configures Storybook's [auto-generated documentation](../../writing-docs/autodocs.mdx).
-## `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 */}
-
-
-
-{/* prettier-ignore-end */}
-
## `defaultName`
Type: `string`
diff --git a/docs/configure/index.mdx b/docs/configure/index.mdx
index 24b8edef495c..9b23aaa9e363 100644
--- a/docs/configure/index.mdx
+++ b/docs/configure/index.mdx
@@ -33,7 +33,7 @@ Storybook's main configuration (i.e., the `main.js|ts`) defines your Storybook p
| `typescript` | Configures how Storybook handles [TypeScript files](./integration/typescript.mdx)
`typescript: { check: false, checkOptions: {} }` |
| `framework` | Configures Storybook based on a set of [framework-specific](./integration/frameworks.mdx) settings
`framework: { name: '@storybook/svelte-vite', options:{} }` |
| `core` | Configures Storybook's [internal features](../api/main-config/main-config-core.mdx)
`core: { disableTelemetry: true, }` |
-| `docs` | Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.mdx)
`docs: { autodocs: 'tag' }` |
+| `docs` | Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.mdx)
`docs: { defaultName: 'Documentation' }` |
| `features` | Enables Storybook's [additional features](../api/main-config/main-config-features.mdx)
See table below for a list of available features |
| `refs` | Configures [Storybook composition](../sharing/storybook-composition.mdx)
`refs: { example: { title: 'ExampleStorybook', url:'https://your-url.com' } }` |
| `logLevel` | Configures Storybook's logs in the browser terminal. Useful for debugging
`logLevel: 'debug'` |
diff --git a/docs/writing-docs/autodocs.mdx b/docs/writing-docs/autodocs.mdx
index 259dd14f1e49..9e5cdae673a7 100644
--- a/docs/writing-docs/autodocs.mdx
+++ b/docs/writing-docs/autodocs.mdx
@@ -57,9 +57,11 @@ In addition to enabling the feature with `tags`, you can extend your Storybook c
{/* prettier-ignore-end */}
-| Option | Description |
-| ------------- | ----------------------------------------------------------------------------------------------------- |
-| `defaultName` | Renames the auto-generated documentation page
Default: `docs: { defaultName: 'Documentation' }` |
+| Option | Description |
+| ---------------------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------|
+| [`defaultName`](../api/main-config/main-config-docs.mdx#defaultname) | Renames the auto-generated documentation page
Default: `docs: { defaultName: 'Docs' }` |
+| [`docsMode`](../api/main-config/main-config-docs.mdx#docsmode) | Toggles the documentation mode, which only shows documentation pages in the sidebar
Default: `docs: { docsMode: false }` |
+
### Write a custom template