GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 16:11:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Addon-docs: document story description (#8535)

Browse Source 
Addon-docs: document story description
This commit is contained in:
Michael Shilman 2019-10-23 23:13:56 +08:00 committed by GitHub
commit eb45dfdd83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
addons/docs/docs/docspage.md
View File

@ -77,6 +77,8 @@ Here is a summary of the slots, where the data comes from by default, and the sl
| Props | component docgen props or propTypes | `propsSlot` | React, Vue | | Props | component docgen props or propTypes | `propsSlot` | React, Vue |
| Stories | storybook stories | `storiesSlot` | All | | Stories | storybook stories | `storiesSlot` | All |
The `storiesSlot` uses the `docs.storyDescription` parameter to show a description for each story, if available.
For more information on frameworks, see ["Framework support"](../README.md#framework-support) For more information on frameworks, see ["Framework support"](../README.md#framework-support)
### Title ### Title
@ -261,7 +263,6 @@ addParameters({
With that function, anyone using the docs addon for `@storybook/vue` can make their stories render inline, either globally with the `inlineStories` docs parameter, or on a per-story-basis using the `inline` prop on the `<Story>` doc block. If you come up with an elegant and flexible implementation for the `prepareForInline` function for your own framework, let us know! We'd love to make it the default configuration, to make inline stories more accessible for a larger variety of frameworks! With that function, anyone using the docs addon for `@storybook/vue` can make their stories render inline, either globally with the `inlineStories` docs parameter, or on a per-story-basis using the `inline` prop on the `<Story>` doc block. If you come up with an elegant and flexible implementation for the `prepareForInline` function for your own framework, let us know! We'd love to make it the default configuration, to make inline stories more accessible for a larger variety of frameworks!
## More resources ## More resources
Want to learn more? Here are some more articles on Storybook Docs: Want to learn more? Here are some more articles on Storybook Docs: