Skip to content

Commit

Permalink
Addon-docs: document story description
Browse files Browse the repository at this point in the history
  • Loading branch information
shilman committed Oct 23, 2019
1 parent 013f1fb commit 1d9d092
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion addons/docs/docs/docspage.md
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

0 comments on commit 1d9d092

Please sign in to comment.