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.

Sign up for GitHub

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

Jump to bottom

Addon-docs: MDX support #7145

Merged
merged 9 commits into from
Jun 24, 2019
Merged

Addon-docs: MDX support #7145

merged 9 commits into from
Jun 24, 2019

Conversation

shilman
Copy link
Member

@shilman shilman commented Jun 19, 2019 •
edited
Loading

Issue: #7101

What I did

Note this builds on #7119 and is temporarily targeted at that PR to highlight the diffs. Should be updated after that gets merged.

  • Add an MDX loader for storybook that converts MDX files into module story format
  • Add presets for addon-docs
  • Add MDX examples

How to test

To test the MDX loader:

yarn jest --testPathPattern mdx-compiler-plugin.test.js

To test end-to-end:

cd examples/official-storybook
yarn storybook
# Check out stories under Addons|Docs/{stories,mdx}

@vercel
Copy link

vercel bot commented Jun 19, 2019 •
edited
Loading

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-7101-mdx.storybook.now.sh

@shilman shilman added this to the 5.2.0 milestone Jun 19, 2019
@shilman shilman mentioned this pull request Jun 19, 2019
Closed
21 tasks
tmeasday
tmeasday approved these changes Jun 19, 2019
View reviewed changes
Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really have enough expertise to say if the AST code is good or not but this seems pretty nice

@vercel vercel bot temporarily deployed to staging June 22, 2019 00:52 Inactive
@shilman shilman changed the base branch from 7101-doc-blocks to next June 22, 2019 00:56
@shilman shilman merged commit 27bcc92 into next Jun 24, 2019
@shilman shilman deleted the 7101-mdx branch June 24, 2019 03:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmeasday tmeasday tmeasday approved these changes

@alterx alterx Awaiting requested review from alterx

@danielduan danielduan Awaiting requested review from danielduan

@igor-dv igor-dv Awaiting requested review from igor-dv

@usulpro usulpro Awaiting requested review from usulpro

@alexandrebodin alexandrebodin Awaiting requested review from alexandrebodin

@dangreenisrael dangreenisrael Awaiting requested review from dangreenisrael

@ndelangen ndelangen Awaiting requested review from ndelangen

@theinterned theinterned Awaiting requested review from theinterned

@thomasbertet thomasbertet Awaiting requested review from thomasbertet

@z4o4z z4o4z Awaiting requested review from z4o4z

Assignees
No one assigned
Labels
addon: docs feature request
Projects
None yet
Milestone
5.2.0
Development

Successfully merging this pull request may close these issues.
2 participants
@shilman @tmeasday