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

mdx stories? #3379

Closed
tsiq-swyx opened this issue Apr 6, 2018 · 14 comments
Closed

mdx stories? #3379

tsiq-swyx opened this issue Apr 6, 2018 · 14 comments

Comments

@tsiq-swyx
Copy link
Contributor

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.

@stale stale bot added the inactive label Apr 28, 2018
@stale stale bot closed this as completed May 28, 2018
@tsiq-swyx
Copy link
Contributor Author

sad

@igor-dv
Copy link
Member

igor-dv commented Jun 4, 2018

@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
Copy link

pupudu commented Sep 3, 2018

@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
Copy link

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

@storybookjs storybookjs deleted a comment from stale bot Sep 25, 2018
@storybookjs storybookjs deleted a comment from stale bot Sep 25, 2018
@ndelangen
Copy link
Member

ndelangen commented Sep 25, 2018

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 ndelangen reopened this Sep 25, 2018
@stale stale bot removed the inactive label Sep 25, 2018
@ndelangen ndelangen self-assigned this Sep 25, 2018
@ndelangen
Copy link
Member

Refining this epic here:
#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
Copy link

stale bot commented Nov 3, 2018

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 stale bot added the inactive label Nov 3, 2018
@stale
Copy link

stale bot commented Dec 3, 2018

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!

@stale stale bot closed this as completed Dec 3, 2018
@centerwork80
Copy link

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
Copy link
Member

shilman commented May 2, 2019

@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
Copy link

smeijer commented May 7, 2019

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
Copy link

Take a look at this package docs.

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

@shilman
Copy link
Member

shilman commented Jun 23, 2019

@smeijer
Copy link

smeijer commented Jun 23, 2019

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

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

No branches or pull requests

9 participants