Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addon-docs: document story description #8535

Merged
merged 1 commit into from
Oct 23, 2019
Merged

Addon-docs: document story description #8535

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion addons/docs/docs/docspage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| 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)

### Title
Expand Down Expand Up @@ -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!


## More resources

Want to learn more? Here are some more articles on Storybook Docs:
Expand Down