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

Update mdx.md #18247

Merged
merged 3 commits into from
May 24, 2022
Merged

Update mdx.md #18247

merged 3 commits into from
May 24, 2022

Conversation

TheeMattOliver
Copy link
Contributor

Adds a recipe for creating a Changelog story, which seems like a pretty common MDX-only docs use case.

Issue:

What I did

Added docs that codify this pattern for adding arbitrary markdown dynamically to an MDX file:

#7644 (comment)

How to test

- [ ] Is this testable with Jest or Chromatic screenshots?
- [ ] Does this need a new example in the kitchen sink apps?

  • [x ] Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

Adds a recipe for creating a Changelog story, which seems like a pretty common MDX-only docs use case.
@nx-cloud
Copy link

nx-cloud bot commented May 18, 2022

☁️ Nx Cloud Report

We didn't find any information for the current pull request with the commit 7a2a78e.
You might need to set the 'NX_BRANCH' environment variable in your CI pipeline.

Check the Nx Cloud Github Integration documentation for more information.


Sent with 💌 from NxCloud.

@yannbf yannbf requested a review from jonniebigodes May 18, 2022 06:24
@yannbf yannbf added documentation addon: docs patch:yes Bugfix & documentation PR that need to be picked to main branch labels May 18, 2022
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@TheeMattOliver thanks for taking the time and effort to help us improve the documentation, we appreciate it. This is shaping up nicely, just a couple of items that need some polish and this will be good to go. Let me know once you've addressed them and I'll gladly merge it.

Hope you have a great day.

Stay safe

docs/writing-docs/mdx.md Outdated Show resolved Hide resolved
docs/writing-docs/mdx.md Show resolved Hide resolved
docs/writing-docs/mdx.md Outdated Show resolved Hide resolved
@jonniebigodes jonniebigodes self-assigned this May 20, 2022
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@TheeMattOliver sorry for the delay in following up with you on this. Looks like there's only one small item to take care of and this will be good to go. Let me know once you've made the change and I'll gladly merge this pull request.

Hope you have a great day!

Stay safe

docs/writing-docs/mdx.md Outdated Show resolved Hide resolved
@jonniebigodes
Copy link
Contributor

@TheeMattOliver thanks for taking care of the feedback so promptly, appreciate it. All is good on my end. Going to merge this.

@jonniebigodes jonniebigodes merged commit af1bbc2 into storybookjs:next May 24, 2022
@shilman shilman added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants