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

Addon docs: Pass remarks plugins to mdx loader #18740

Merged

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Jul 19, 2022

Issue: #18395

What I did

During the refactor to support mdx2, the mdxLoader options were missed.
This PR brings them back, so the remark plugins are passed and anchor tags now work in docs stories:

image

How to test

  1. Spin up official-storybook
  2. Open a docs only story, e.g. basics-typography--page
  3. Assert whether the anchor icon appears when you hover a title
  • Is this testable with Jest or Chromatic screenshots?
  • Does this need a new example in the kitchen sink apps?
  • 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.

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch addon: docs labels Jul 19, 2022
@nx-cloud
Copy link

nx-cloud bot commented Jul 19, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b6b6cf1. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

LGTM great fix

@shilman shilman merged commit 45a6c25 into future/base Jul 20, 2022
@shilman shilman deleted the yann/sb-414-sb18395-cannot-anchor-to-headings-in-mdx branch July 20, 2022 16:58
shilman added a commit that referenced this pull request Sep 28, 2022
…-anchor-to-headings-in-mdx

Addon docs: Pass remarks plugins to mdx loader
@shilman shilman removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jun 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants