Skip to content

Commit f3925a2

Browse files
authored
Merge pull request #32538 from storybookjs/version-patch-from-9.1.8
Release: Merge patches to `main` (without version bump)
2 parents 28833d4 + b1cdaab commit f3925a2

File tree

7 files changed

+11
-51
lines changed

7 files changed

+11
-51
lines changed

docs/_snippets/main-config-docs-autodocs.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/_snippets/main-config-typical.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ const config = {
77
// Optional
88
addons: ['@storybook/addon-docs'],
99
docs: {
10-
autodocs: 'tag',
10+
defaultName: 'Documentation',
1111
},
1212
staticDirs: ['../public'],
1313
};
@@ -25,7 +25,7 @@ const config: StorybookConfig = {
2525
// Optional
2626
addons: ['@storybook/addon-docs'],
2727
docs: {
28-
autodocs: 'tag',
28+
defaultName: 'Documentation',
2929
},
3030
staticDirs: ['../public'],
3131
};

docs/_snippets/storybook-auto-docs-full-config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ export default {
77
docs: {
88
//👇 See the table below for the list of supported options
99
defaultName: 'Documentation',
10+
docsMode: true,
1011
},
1112
};
1213
```
@@ -22,6 +23,7 @@ const config: StorybookConfig = {
2223
docs: {
2324
//👇 See the table below for the list of supported options
2425
defaultName: 'Documentation',
26+
docsMode: true,
2527
},
2628
};
2729

docs/api/main-config/main-config-docs.mdx

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,13 @@ Type:
1111

1212
```ts
1313
{
14-
autodocs?: boolean | 'tag';
1514
defaultName?: string;
1615
docsMode?: boolean;
1716
}
1817
```
1918

2019
Configures Storybook's [auto-generated documentation](../../writing-docs/autodocs.mdx).
2120

22-
## `autodocs`
23-
24-
Type: `boolean | 'tag'`
25-
26-
Default: `'tag'`
27-
28-
Enables or disables automatic documentation for stories.
29-
30-
* `true`: Enables it for all stories
31-
* `false`: Disables it for all stories
32-
* `'tag'`: Enables it for stories tagged with `'autodocs'`
33-
34-
{/* prettier-ignore-start */}
35-
36-
<CodeSnippets path="main-config-docs-autodocs.md" />
37-
38-
{/* prettier-ignore-end */}
39-
4021
## `defaultName`
4122

4223
Type: `string`

docs/configure/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Storybook's main configuration (i.e., the `main.js|ts`) defines your Storybook p
3333
| `typescript` | Configures how Storybook handles [TypeScript files](./integration/typescript.mdx) <br /> `typescript: { check: false, checkOptions: {} }` |
3434
| `framework` | Configures Storybook based on a set of [framework-specific](./integration/frameworks.mdx) settings <br /> `framework: { name: '@storybook/svelte-vite', options:{} }` |
3535
| `core` | Configures Storybook's [internal features](../api/main-config/main-config-core.mdx) <br /> `core: { disableTelemetry: true, }` |
36-
| `docs` | Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.mdx)<br /> `docs: { autodocs: 'tag' }` |
36+
| `docs` | Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.mdx)<br /> `docs: { defaultName: 'Documentation' }` |
3737
| `features` | Enables Storybook's [additional features](../api/main-config/main-config-features.mdx)<br /> See table below for a list of available features |
3838
| `refs` | Configures [Storybook composition](../sharing/storybook-composition.mdx) <br /> `refs: { example: { title: 'ExampleStorybook', url:'https://your-url.com' } }` |
3939
| `logLevel` | Configures Storybook's logs in the browser terminal. Useful for debugging <br /> `logLevel: 'debug'` |

docs/versions/next.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"version":"10.0.0-beta.6","info":{"plain":"- Core: Add \\\"open in editor\\\" feature - [#32452](https://github.com/storybookjs/storybook/pull/32452), thanks @yannbf!\n- Dev: Improve the browser opening experience - [#32488](https://github.com/storybookjs/storybook/pull/32488), thanks @ndelangen!\n- Maintenance: Remove globalization for dropped entrypoints - [#32491](https://github.com/storybookjs/storybook/pull/32491), thanks @ndelangen!\n- Telemetry: Queue error reporting & filter browser-extention - [#32499](https://github.com/storybookjs/storybook/pull/32499), thanks @ndelangen!\n- Upgrade: Packages `open` - [#32484](https://github.com/storybookjs/storybook/pull/32484), thanks @ndelangen!"}}
1+
{"version":"10.0.0-beta.7","info":{"plain":"- Addon A11y: Prevent setting highlights for old results - [#32178](https://github.com/storybookjs/storybook/pull/32178), thanks @ghengeveld!\n- AddonViewport: Stricter types - [#32324](https://github.com/storybookjs/storybook/pull/32324), thanks @hpohlmeyer!\n- CSF: Add Storybook test syntax (Storybook v10) - [#32455](https://github.com/storybookjs/storybook/pull/32455), thanks @yannbf!\n- Controls: Allow primitive values of ReactNode argType - [#31931](https://github.com/storybookjs/storybook/pull/31931), thanks @alexey-kozlenkov!\n- Core: Prevent `BAIL` state from showing in interactions panel when switching stories - [#32172](https://github.com/storybookjs/storybook/pull/32172), thanks @ghengeveld!\n- CoreServer: Fix `Arc can't get every window` - [#32508](https://github.com/storybookjs/storybook/pull/32508), thanks @ndelangen!\n- Dts: Ensure `.tsx` files emit `.d.ts` type files - [#32461](https://github.com/storybookjs/storybook/pull/32461), thanks @mrginglymus!\n- Svelte: Improve support for async components - [#31476](https://github.com/storybookjs/storybook/pull/31476), thanks @JReinhold!\n- SvelteKit: Add support for mocking `$app/state` - [#31369](https://github.com/storybookjs/storybook/pull/31369), thanks @xeho91!\n- SvelteKit: Fix `set_context_after_init` error when experimental async is enabled - [#32513](https://github.com/storybookjs/storybook/pull/32513), thanks @Jakeii!\n- UI: Allow showing or hiding the addon panel - [#32348](https://github.com/storybookjs/storybook/pull/32348), thanks @Sidnioulz!"}}

docs/writing-docs/autodocs.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,11 @@ In addition to enabling the feature with `tags`, you can extend your Storybook c
5757

5858
{/* prettier-ignore-end */}
5959

60-
| Option | Description |
61-
| ------------- | ----------------------------------------------------------------------------------------------------- |
62-
| `defaultName` | Renames the auto-generated documentation page<br /> Default: `docs: { defaultName: 'Documentation' }` |
60+
| Option | Description |
61+
| ---------------------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------|
62+
| [`defaultName`](../api/main-config/main-config-docs.mdx#defaultname) | Renames the auto-generated documentation page<br /> Default: `docs: { defaultName: 'Docs' }` |
63+
| [`docsMode`](../api/main-config/main-config-docs.mdx#docsmode) | Toggles the documentation mode, which only shows documentation pages in the sidebar<br /> Default: `docs: { docsMode: false }` |
64+
6365

6466
### Write a custom template
6567

0 commit comments

Comments
 (0)