diff --git a/docs/api/doc-block-argtypes.md b/docs/api/doc-block-argtypes.md index a7aaf4775844..7ee304217ce5 100644 --- a/docs/api/doc-block-argtypes.md +++ b/docs/api/doc-block-argtypes.md @@ -2,6 +2,8 @@ title: 'ArgTypes' --- + + The `ArgTypes` block can be used to show a static table of [arg types](./argtypes.md) for a given component, as a way to document its interface.
diff --git a/docs/api/doc-block-canvas.md b/docs/api/doc-block-canvas.md index a77fb401d1f0..8c27490bacb8 100644 --- a/docs/api/doc-block-canvas.md +++ b/docs/api/doc-block-canvas.md @@ -2,6 +2,8 @@ title: 'Canvas' --- + + The `Canvas` block is a wrapper around a [`Story`](./doc-block-story.md), featuring a toolbar that allows you to interact with its content while automatically providing the required [`Source`](./doc-block-source.md) snippets. ![Screenshot of Canvas block](./doc-block-canvas.png) diff --git a/docs/api/doc-block-controls.md b/docs/api/doc-block-controls.md index 133ceed32c1c..835384203a5c 100644 --- a/docs/api/doc-block-controls.md +++ b/docs/api/doc-block-controls.md @@ -2,6 +2,8 @@ title: 'Controls' --- + + The `Controls` block can be used to show a dynamic table of args for a given story, as a way to document its interface, and to allow you to change the args for a (separately) rendered story (via the [`Story`](./doc-block-story.md) or [`Canvas`](./doc-block-canvas.md) blocks).
diff --git a/docs/api/doc-block-description.md b/docs/api/doc-block-description.md index e9efa50e2e9e..1c188a239349 100644 --- a/docs/api/doc-block-description.md +++ b/docs/api/doc-block-description.md @@ -2,6 +2,8 @@ title: 'Description' --- + + The `Description` block displays the description for a component, story, or meta, obtained from their respective JSDoc comments. ![Screenshot of Description block](./doc-block-title-subtitle-description.png) diff --git a/docs/api/doc-block-primary.md b/docs/api/doc-block-primary.md index be806ab0c50b..5d124df65b9f 100644 --- a/docs/api/doc-block-primary.md +++ b/docs/api/doc-block-primary.md @@ -2,6 +2,8 @@ title: 'Primary' --- + + The `Primary` block displays the primary (first defined in the stories file) story, in a [`Story`](./doc-block-story.md) block. It is typically rendered immediately under the title in a docs entry. ![Screenshot of Primary block](./doc-block-primary.png) diff --git a/docs/api/doc-block-source.md b/docs/api/doc-block-source.md index 7e80d698f0e8..0595c387a238 100644 --- a/docs/api/doc-block-source.md +++ b/docs/api/doc-block-source.md @@ -2,6 +2,8 @@ title: 'Source' --- + + The `Source` block is used to render a snippet of source code directly. ![Screenshot of Source block](./doc-block-source.png) diff --git a/docs/api/doc-block-stories.md b/docs/api/doc-block-stories.md index 657e27beab32..75728b54df71 100644 --- a/docs/api/doc-block-stories.md +++ b/docs/api/doc-block-stories.md @@ -2,6 +2,8 @@ title: 'Stories' --- + + The `Stories` block renders the full collection of stories in a stories file. ![Screenshot of Stories block](./doc-block-stories.png) diff --git a/docs/api/doc-block-story.md b/docs/api/doc-block-story.md index 1532740946fd..89499df3328c 100644 --- a/docs/api/doc-block-story.md +++ b/docs/api/doc-block-story.md @@ -2,6 +2,8 @@ title: 'Story' --- + + Stories (component tests) are Storybook's fundamental building blocks. In Storybook Docs, you can render any of your stories from your CSF files in the context of an MDX file with all annotations (parameters, args, loaders, decorators, play function) applied using the `Story` block. @@ -124,6 +126,8 @@ Type: Story export Specifies which story is rendered by the `Story` block. If no `of` is defined and the MDX file is [attached](./doc-block-meta.md#attached-vs-unattached), the primary (first) story will be rendered. + + ### `args` (⛔️ **Deprecated**) diff --git a/docs/api/doc-block-subtitle.md b/docs/api/doc-block-subtitle.md index f0d1d5ed5a6c..1104184c9992 100644 --- a/docs/api/doc-block-subtitle.md +++ b/docs/api/doc-block-subtitle.md @@ -2,6 +2,8 @@ title: 'Subtitle' --- + + The `Subtitle` block can serve as a secondary heading for your docs entry. ![Screenshot of Subtitle block](./doc-block-title-subtitle-description.png) diff --git a/docs/api/doc-block-title.md b/docs/api/doc-block-title.md index acdc1cee0f90..886d19075386 100644 --- a/docs/api/doc-block-title.md +++ b/docs/api/doc-block-title.md @@ -2,6 +2,8 @@ title: 'Title' --- + + The `Title` block serves as the primary heading for your docs entry. It is typically used to provide the component or page name. ![Screenshot of Title block](./doc-block-title-subtitle-description.png) diff --git a/docs/sharing/embed.md b/docs/sharing/embed.md index 01b697f3f62a..fac0efba259c 100644 --- a/docs/sharing/embed.md +++ b/docs/sharing/embed.md @@ -2,6 +2,8 @@ title: 'Embed stories' --- + + Embed stories to showcase your work to teammates and the developer community at large. In order to use embeds, your Storybook must be published and publicly accessible. Storybook supports `