Skip to content

Update MDX documentation to use next-mdx-remote-client #78347

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
Merged
merged 3 commits into from
Apr 28, 2025
Merged

Update MDX documentation to use next-mdx-remote-client #78347

merged 3 commits into from
Apr 28, 2025
+36 −15

Conversation

gaearon
Copy link
Contributor

@gaearon gaearon commented Apr 20, 2025

From what I understand, this is the latest recommendations. I've gotten issues with next-mdx-remote recently.

@ijjk ijjk added the Documentation Related to Next.js' official documentation. label Apr 20, 2025
@ijjk
Copy link
Member

ijjk commented Apr 20, 2025

Allow CI Workflow Run

  • approve CI run for commit: 5c0faaf

Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer

@glekner
Copy link

glekner commented Apr 22, 2025

@talatkuyuk 🎉

@talatkuyuk
Copy link

It’s an honor to see next-mdx-remote-client mentioned in the Next.js documentation. I'm truly grateful ❤️

delbaoliveira
delbaoliveira reviewed Apr 22, 2025
View reviewed changes
Copy link
Contributor

@delbaoliveira delbaoliveira left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you Dan, this is some good stuff. Let me learn more about next-mdx-remote-client before merging.

@gaearon
Copy link
Contributor Author

gaearon commented Apr 22, 2025

Yea I don't actually know if it's recommended or either is better (cc @eps1lon). I just ran into #76395 (comment) and then migrating to -client fixed it.

talatkuyuk
talatkuyuk reviewed Apr 23, 2025
View reviewed changes
Copy link

@talatkuyuk talatkuyuk left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I added 2 reviews for better documentation in case PR is merged since a type guard / or property existence check is needed always to get SerializeResult properly. Because next-mdx-remote-client has internal error handling mechanism against syntax errors in mdx contents

@eps1lon eps1lon merged commit f7eaa86 into vercel:canary Apr 28, 2025
42 checks passed
@talatkuyuk
Copy link

Thanks so much for reviewing, and contributing @delba; and merging the update @eps1lon, and to you @gaearon for creating this PR. I am thrilled to see next-mdx-remote-client is included in the canary docs and hope it to be in the official Next.js docs.

As the author of next-mdx-remote-client, contributing to the MDX ecosystem is something I truly enjoy. It's rewarding to see these efforts recognized and valued by the community. Thanks again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@talatkuyuk talatkuyuk talatkuyuk left review comments

@eps1lon eps1lon eps1lon approved these changes

@delbaoliveira delbaoliveira delbaoliveira approved these changes

Assignees
No one assigned
Labels
Documentation Related to Next.js' official documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@gaearon @ijjk @glekner @talatkuyuk @eps1lon @delbaoliveira