Storybook: mdx stories?

[tsiq-swyx]

just an idea for general discussion - any interest in writing stories in guillermo rauch's mdx?

https://github.com/mdx-js/mdx

i was honestly surprised no one seems to have suggested this yet. seems like a very natural pairing.

[tsiq-swyx]

sad

[igor-dv]

@tsiq-swyx, I am not sure we need to support this in the core. Looks like it can be configured with a custom mode, (like TS or Flow 🤷‍♂️ )

[pupudu]

@tsiq-swyx I had the same thought. People are moving away from storybook to docz, and this is one of the reasons. Should be really convenient for everyone if addons like info supported mdx

[StanLindsey]

I think this really suits Storybook. We already display React Component's paired with markdown readmes. This would fit nicely out of the box.

[ndelangen]

Hi Shawn, YES! This is on our roadmap, and we've started work on this already, Sorry for the silence, and the bot closing.

mdx support is coming to the core, so stories are still rendered in complete isolation.

In other words what we're going to do is:

1. render mdx in a secondary view-mode
2. extracting code samples or story references
3. rending an iframe for each and render the code-sample or story in there.

[ndelangen]

Refining this epic here:
https://github.com/storybooks/storybook/issues/4341

We could use help, so if you're reading this, please contact me if there's something you might be able to do to help.

[stale[bot]]

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

[stale[bot]]

Hey there, it's me again! I am going close this issue to help our maintainers focus on the current development roadmap instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!

[centerwork80]

Just a quick update that I found on this today. Looks like they hit it out of the park.

Storybook Docs sneak peek
https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a

[shilman]

@centerwork80 @tsiq-swyx We have a technical preview released on the 5.2.0-alpha.x releases. In the process of structuring the work & release cycle in #docs-mode on our Discord https://discord.gg/UUt2PJb

[smeijer]

Is there a way to try out / get started with that sneak peak version? Since I've used docz for one of my projects, I'm considering switching all my projects to docz instead of storybook. That was until I saw the medium blog.

Unfortunately, I cannot find any "try it now!" docs. Those would be very helpful, to see if it's something worth waiting for.

[centerwork80]

Take a look at this package docs.

https://www.npmjs.com/package/@storybook/addon-docs

[shilman]

@smeijer just saw this comment. here's the guide you want https://docs.google.com/document/d/1un6YX7xDKEKl5-MVb-egnOYN8dynb5Hf7mq0hipk8JE/edit?usp=sharing

[smeijer]

@shilman, thanks. I did find my way after @centerwork80 hinted me to look at @storybook/addon-docs.