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

docs: Correct place for passing extension option to createMDX() #55967

Merged
merged 2 commits into from Sep 25, 2023

Conversation

eliot-akira
Copy link
Contributor

What?

Fixing a little mistake in the documentation, where the placement of the extension option for createMDX() was described as being inside the options property:

const withMDX = createMDX({
  options: {
    extension: /\.mdx?$/,

But it's actually a property of its own:

const withMDX = createMDX({
  extension: /\.mdx?$/,

I confirmed that the latter is correct because:

Copy link

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca

@styfle styfle added the CI approved Approve running CI for fork label Sep 25, 2023
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Thanks!

@kodiakhq kodiakhq bot merged commit 9d86c12 into vercel:canary Sep 25, 2023
58 checks passed
@eliot-akira eliot-akira deleted the docs-correct-extension-option branch October 3, 2023 02:02
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CI approved Approve running CI for fork locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants