How to use addon-docs like addon-notes? #14156
Replies: 3 comments
-
If you use MDX to write stories, it will get closer to what you might want to achieve. While there is no dedicated field for notes, |
Beta Was this translation helpful? Give feedback.
-
If you follow this recipe, you can associate an MDX file with a story: https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/recipes.md#csf-stories-with-arbitrary-mdx If you only put markdown in the story, you can approximately achieve the Notes behavior. @jonniebigodes we should get this into the official documentation |
Beta Was this translation helpful? Give feedback.
-
Sorry for getting back to this one that late. MDX is no option, we're using TSX files consequently. Following the migration notes at https://github.com/storybookjs/storybook/blob/next/addons/docs/docs/recipes.md#migrating-from-notesinfo-addons results in the component description being replaced with the notes. We want(ed) to show notes additionally in an extra tab. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Or in other words: how can
addon-docs
be used for showing story specific notes as we were able to do so withaddon-notes
?I already use
addon-docs
for displaying component'sJSDoc
. It works great!I need to display additional notes for each story, like a little how-to or guide on what exactly is being addressed in that story.
As i can see on https://github.com/storybookjs/storybook,
addon-docs
is the addon toand
addon-notes
to=> component level vs. story level
So unfortunately i don't have any clue how to deal with
Beta Was this translation helpful? Give feedback.
All reactions