Skip to content

Commit

Permalink
Fix errors introduced in #28375
Browse files Browse the repository at this point in the history
  • Loading branch information
kylegach committed Jun 28, 2024
1 parent 5defd98 commit 93337c2
Show file tree
Hide file tree
Showing 15 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-argtypes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `ArgTypes` block can be used to show a static table of [arg types](../arg-ty
If you’re looking for a dynamic table that shows a story’s current arg values for a story and supports users changing them, see the [`Controls`](./doc-block-controls.mdx) block instead.
</Callout>

![Screenshot of ArgTypes block](../../_assets/doc-block-argtypes.png)
![Screenshot of ArgTypes block](../../_assets/api/doc-block-argtypes.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-canvas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Canvas` block is a wrapper around a [`Story`](./doc-block-story.mdx), featuring a toolbar that allows you to interact with its content while automatically providing the required [`Source`](./doc-block-source.mdx) snippets.

![Screenshot of Canvas block](../../_assets/doc-block-canvas.png)
![Screenshot of Canvas block](../../_assets/api/doc-block-canvas.png)

When using the Canvas block in MDX, it references a story with the `of` prop:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-colorpalette.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `ColorPalette` block allows you to document all color-related items (e.g., swatches) used throughout your project.

![Screenshot of ColorPalette and ColorItem blocks](../../_assets/doc-block-colorpalette.png)
![Screenshot of ColorPalette and ColorItem blocks](../../_assets/api/doc-block-colorpalette.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-controls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The `Controls` block can be used to show a dynamic table of args for a given sto
If you’re looking for a static table that shows a component's arg types with no controls, see the [`ArgTypes`](./doc-block-argtypes.mdx) block instead.
</Callout>

![Screenshot of Controls block](../../_assets/doc-block-controls.png)
![Screenshot of Controls block](../../_assets/api/doc-block-controls.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-description.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Description` block displays the description for a component, story, or meta, obtained from their respective JSDoc comments.

![Screenshot of Description block](../../_assets/doc-block-title-subtitle-description.png)
![Screenshot of Description block](../../_assets/api/doc-block-title-subtitle-description.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-icongallery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `IconGallery` block enables you to easily document React icon components associated with your project, displayed in a neat grid.

![Screenshot of IconGallery and IconItem blocks](../../_assets/doc-block-icongallery.png)
![Screenshot of IconGallery and IconItem blocks](../../_assets/api/doc-block-icongallery.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-markdown.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:

The `Markdown` block allows you to import and include plain markdown in your MDX files.

![Screenshot of Markdown block](../../_assets/doc-block-markdown.png)
![Screenshot of Markdown block](../../_assets/api/doc-block-markdown.png)

When importing markdown files, it’s important to use the `?raw` suffix on the import path to ensure the content is imported as-is, and isn’t being evaluated:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-primary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Primary` block displays the primary (first defined in the stories file) story, in a [`Story`](./doc-block-story.mdx) block. It is typically rendered immediately under the title in a docs entry.

![Screenshot of Primary block](../../_assets/doc-block-primary.png)
![Screenshot of Primary block](../../_assets/api/doc-block-primary.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Source` block is used to render a snippet of source code directly.

![Screenshot of Source block](../../_assets/doc-block-source.png)
![Screenshot of Source block](../../_assets/api/doc-block-source.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Stories` block renders the full collection of stories in a stories file.

![Screenshot of Stories block](../../_assets/doc-block-stories.png)
![Screenshot of Stories block](../../_assets/api/doc-block-stories.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-story.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In Storybook Docs, you can render any of your stories from your CSF files in the
Typically you want to use the [`Canvas` block](./doc-block-canvas.mdx) to render a story with a surrounding border and the source block, but you can use the `Story` block to render just the story.
</Callout>

![Screenshot of Story block](../../_assets/doc-block-story.png)
![Screenshot of Story block](../../_assets/api/doc-block-story.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-subtitle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Subtitle` block can serve as a secondary heading for your docs entry.

![Screenshot of Subtitle block](../../_assets/doc-block-title-subtitle-description.png)
![Screenshot of Subtitle block](../../_assets/api/doc-block-title-subtitle-description.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-title.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

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](../../_assets/doc-block-title-subtitle-description.png)
![Screenshot of Title block](../../_assets/api/doc-block-title-subtitle-description.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-typeset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:

The `Typeset` block helps document the fonts used throughout your project.

![Screenshot of Typeset block](../../_assets/doc-block-typeset.png)
![Screenshot of Typeset block](../../_assets/api/doc-block-typeset.png)

{/* prettier-ignore-start */}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/doc-blocks/doc-block-unstyled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ import { Header } from "./Header.tsx";

Yields:

![Screenshot of Unstyled Doc Block](../../_assets/doc-block-unstyled.png)
![Screenshot of Unstyled Doc Block](../../_assets/api/doc-block-unstyled.png)

<Callout variant="info">
The other blocks like [`Story`](./doc-block-story.mdx) and [`Canvas`](./doc-block-canvas.mdx) are already unstyled, so there’s no need to wrap those in the `Unstyled` block to ensure that Storybook’s styles don’t bleed into the stories. However, if you import your components directly in the MDX, you most likely want to wrap them in the Unstyled block.
Expand Down

0 comments on commit 93337c2

Please sign in to comment.