Turn your stories into living documentation.
Storybook is the leading component workshop, now we're making it a lot easier to create a storefront for your design system.
What it is:
- Embeddable stories
- New story format
docs
addon =notes
+info
Goals:
- Short-term (5.1?): technical infrastructure to support styleguide documentation from stories
- Medium-term (6.0?): design and build best practices for component styleguides into Storybook
- Long-term (???): make stories pervasive across entire front-end ecosystem
Typescript React component library for:
- stories
- props table
- tsdoc / jsdoc / docgen
- source?
Embed these components in storybook or in other documentation sites e.g. Gatsby, etc.
Show multiple stories on the same screen, using some method TBD:
- Multiple iframes (prototyped by @ndelangen)
- Embeddable react (will POC)
- Overriding JSX tags (will investigate)
Make it easier to write stories without exposing the story store:
- designed/prototyped by @tmeasday (design)
- update as needed to support doc blocks
- document for release
New addon to replace notes
and info
:
- Run in manager
- Take advantage of 5.0 addons APIs
- Reference other stories
May simply improve upon what's there, or grow into a core "storefront" feature of Storybook (TBD @domyen)