Replies: 2 comments
-
We would be able to add Figma Designs to the docs pages only: // component.docs.mdx
import { Figma } from '@storybook/addon-designs/blocks';
<Figma url="{url-to-your-figma-file}"/> |
Beta Was this translation helpful? Give feedback.
0 replies
-
As blocks are available for key addons, the team decided to go forward with the docs mode. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Storybook v7 has a docs mode: https://storybook.js.org/docs/7.1/react/writing-docs/build-documentation
In this mode, all story playgrounds are hidden and only
.mdx
docs are visible in the navigation. This enables a very clean look for the documentation because there is only one navigation entry per component. The stories would still be written the same way, but won't show up in the navigation.On the other hand, addon functionality that's only displayed in the playground will be disabled or hidden. Examples are the storybook designs addon or the storybook accessibility addon. While there might be other ways of adding this functionality to the docs, it most likely means more complexity.
In stories mode, the docs are displayed as well and are the default landing page when clicking a component top-level entry in the navigation.
What are your thoughts, do you prefer functionality or simplicity?
4 votes ·
Beta Was this translation helpful? Give feedback.
All reactions