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

Investigate & upgrade next-mdx-remote to v4 #11938

Closed
pettinarip opened this issue Nov 3, 2023 · 6 comments
Closed

Investigate & upgrade next-mdx-remote to v4 #11938

pettinarip opened this issue Nov 3, 2023 · 6 comments
Assignees
Labels
dev required This requires developer resources tooling 🔧 Changes related to tooling of the project

Comments

@pettinarip
Copy link
Member

pettinarip commented Nov 3, 2023

Important: we can't upgrade to v4 with the current code as it is. See ethereum#18 for more details about why we downgraded to v3.

Investigate how to fix the issues we have with next-mdx-remote v4 and upgrade it https://github.com/hashicorp/next-mdx-remote

We could potentially replace gray-matter since the new version can parse frontmatter as well and simplify a bit the code.

const mdxSource = await serialize(source, { parseFrontmatter: true })
@github-actions github-actions bot added the needs triage 📥 This issue needs triaged before being worked on label Nov 3, 2023
@pettinarip pettinarip changed the title Upgrade next-mdx-remote Investigate & upgrade next-mdx-remote to v4 Nov 3, 2023
@TylerAPfledderer
Copy link
Contributor

TylerAPfledderer commented Nov 10, 2023

@pettinarip took time to check this out. Did a bump to [email protected] which looks to be the minimum version to jump to minimize any needed changes.

  • With heading ids, the beginning curly brace needs to be escaped so it is not interpreted as an expression syntax. See parse expression error troubleshoot.
    ## Official Ethereum support {#official-support} => ## Official Ethereum support \{#official-support}
  • Regarding text content inside components: I think wrapping the text content only in an expression would be the most natural
<DocLink>
  { "Ethereum security and scam prevention" }
</DocLink>
  • As of now, have not investigated further on the removal of gray-matter.

I am not seeing anything else to address at that version to prevent breaking.

Anything different you have in mind here?

Copy link
Contributor

This issue is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Dec 26, 2023
@pettinarip pettinarip transferred this issue from ethereum/ethereum-org-fork Jan 16, 2024
@TylerAPfledderer
Copy link
Contributor

@pettinarip commenting for assignment, per private discussion, and I will attempt to use my suggestion above to see what effect it has at this point.

@pettinarip
Copy link
Member Author

@TylerAPfledderer assigned, thanks!

@github-actions github-actions bot removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jan 30, 2024
Copy link
Contributor

This issue is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Mar 15, 2024
@wackerow wackerow added tooling 🔧 Changes related to tooling of the project dev required This requires developer resources and removed Status: Stale This issue is stale because it has been open 30 days with no activity. needs triage 📥 This issue needs triaged before being worked on labels Jun 13, 2024
@wackerow
Copy link
Member

Closing via this comment: #12055 (comment)

@wackerow wackerow closed this as not planned Won't fix, can't repro, duplicate, stale Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev required This requires developer resources tooling 🔧 Changes related to tooling of the project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants