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.

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

How do we include markdown in between stories without MDX? #44

Open
matthew-dean opened this issue May 12, 2022 · 0 comments
Open

How do we include markdown in between stories without MDX? #44

matthew-dean opened this issue May 12, 2022 · 0 comments

Comments

@matthew-dean
Copy link

matthew-dean commented May 12, 2022

In blog posts, it mentions that MDX compiles down to CSF. But it doesn't say how or how to define MDX features within a CSF.

The use case is that MDX is hard to debug. It doesn't have auto-complete or TypeScript support, and we sometimes get errors that are not easy to reason about. Whereas CSF is usually more straightforward with more logical errors.

However, there doesn't seem to be any clear API / spec for CSF anywhere. This repo points to https://storybook.js.org/docs/react/api/csf and there it says there's an "open standard" which points to this repo. But what is the spec exactly? What are all available exports and the supported object keys? How does one provide documentation in between stories? How does MDX compile / transpile to CSF?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant