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

Improvements to the MDX Docs and replaced a leftover reference to babel #35332

Merged
merged 17 commits into from Apr 11, 2022
Merged

Improvements to the MDX Docs and replaced a leftover reference to babel #35332

merged 17 commits into from Apr 11, 2022

Conversation

Markos-Th09
Copy link
Contributor

@Markos-Th09 Markos-Th09 commented Mar 15, 2022

Documentation / Examples

  • Make sure the linting passes by running yarn lint

This PR adds the next.config.mjs version of the configuration, required for using remark and rehype plugins and adds a configuration for frontmatter. It also replaces a leftover reference to babel in next.config.js introduction page
Also shoutout to @homumado for helping get this information

@Nutlope Nutlope requested a review from molebox March 15, 2022 20:10
@balazsorban44 balazsorban44 merged commit 5bf7265 into vercel:canary Apr 11, 2022

## @mdx-js/mdx

Handle mdx strings client side, probably @mdx-js/mdx see official docs https://mdxjs.com/docs/getting-started/
Copy link
Member

Choose a reason for hiding this comment

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

Can we revert this or fix forward? This is not a complete sentence or using a correct link.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah I think we should revert based on my other comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah it needs to be fixed

@@ -56,6 +56,27 @@ The following steps outline how to setup `@next/mdx` in your Next.js project:
})
```

> Using MDX plugins will require using next.config.mjs because all the plugins are [ECMAScript modules](https://nodejs.org/api/esm.html)
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is accurate. Could someone confirm?

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think this is accurate. Could someone confirm?

Most plugins are esm modules. Even remark and rehype themselves are.

Copy link
Member

Choose a reason for hiding this comment

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

cc @timneutkens, who told me it was correct.

@Markos-Th09
Copy link
Contributor Author

I am going to fix those issues and open a new PR

kodiakhq bot pushed a commit that referenced this pull request Apr 11, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 12, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants