mirror of
https://github.com/storybookjs/storybook.git
synced 2025-03-19 05:02:40 +08:00
Merge pull request #12105 from pascalduez/docs/hotfix/links
Docs - fix links leading to 404s
This commit is contained in:
commit
0aeb3afcff
@ -4,7 +4,8 @@ title: 'Doc Blocks'
|
||||
|
||||
Doc Blocks are the building blocks of Storybook documentation pages. By default, [DocsPage](./docs-page.md) uses a combination of the blocks below to build a page for each of your components automatically.
|
||||
|
||||
Custom [addons](../configure/storybook-addons.md) can also provide their own doc blocks.
|
||||
|
||||
Custom [addons](../api/addons.md) can also provide their own doc blocks.
|
||||
|
||||
## ArgsTable
|
||||
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: 'DocsPage'
|
||||
---
|
||||
|
||||
When you install [Storybook Docs](https://github.com/storybookjs/storybook/blob/next/addons/docs/), DocsPage is the zero-config default documentation that all stories get out of the box. It aggregates your stories, text descriptions, docgen comments, args tables, and code examples into a single page for each component.
|
||||
When you install [Storybook Docs](../../addons/docs/README.md), DocsPage is the zero-config default documentation that all stories get out of the box. It aggregates your stories, text descriptions, docgen comments, args tables, and code examples into a single page for each component.
|
||||
|
||||
The best practice for docs is for each component to have its own set of documentation and stories.
|
||||
|
||||
|
@ -104,7 +104,7 @@ Typically, when you use Storybook MDX, you define stories in the MDX and documen
|
||||
|
||||
If you don't define stories in your MDX, you can write MDX documentation and associate it with an existing story, or embed that MDX as its own documentation node in your Storybook's navigation.
|
||||
|
||||
If you don't define a Meta, you can write Markdown and associate with an existing story. See ["CSF Stories with MDX Docs"](https://github.com/storybookjs/storybook/blob/master/addons/docs/docs/recipes.md#csf-stories-with-mdx-docs).
|
||||
If you don't define a Meta, you can write Markdown and associate with an existing story. See ["CSF Stories with MDX Docs"](../../addons/docs/docs/recipes.md).
|
||||
|
||||
To get a "documentation-only story", in your UI, define a `<Meta>` as you normally would, but don't define any stories. It will show up in your UI as a documentation node:
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user