chore(deps): update markdown-related dependencies #1001
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I'm trying out web-infra-dev#574. The `@shikijs/rehype` uses a higher version of `unified` than Rspress. So I decide to first upgrade the dependencies of Rspress. Upgrade `@mdxjs/*`, `hast-*`, `mdast-util-*`, `rehype-*`, `remark-*`, `unist-util-*` and `unified` to latest. Please note that these are major bump with breaking changes(mostly typings). The `remarkPlugins/toc.ts` and `remarkPlugins/loader.ts` have been updated for correct types. I've tried running Rspack and Rsbuild documentation with the upgraded Rspress. Everyting looks just fine!
|
|
The `remakr-*` contains only typing major changes. Overrides to higher version to reduce installation size.
✅ Deploy Preview for aquamarine-blini-95325f ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
chenjiahan
reviewed
Apr 22, 2024
| "@mdx-js/mdx": "2.3.0", | ||
| "@mdx-js/react": "2.3.0", | ||
| "@mdx-js/loader": "3.0.1", | ||
| "@mdx-js/mdx": "3.0.1", |
There was a problem hiding this comment.
I'm worried that mdx v3 and remark v15 contains some breaking changes and may break the user code / plugins.
There was a problem hiding this comment.
I believe the mdx-rs of Rspress use the mdx v2 syntax, @sanyuan0704 can you confirm this?
There was a problem hiding this comment.
Looks like mdx v3 updates the rehype and remark, which contains breaking changes mainly in typings. This is indeed a breaking change for Rspress users, but migration is easy. Just update the rehype and remark plugins.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
I'm trying out #574. The
@shikijs/rehypeuses a higher version ofunifiedthan Rspress. So I decided to first upgrade the dependencies ofRspress.
Upgrade
@mdxjs/*,hast-*,mdast-util-*,rehype-*,remark-*,unist-util-*andunifiedto latest.Please note that these are major bumps with breaking changes(mostly
typings). The
remarkPlugins/toc.tsandremarkPlugins/loader.tshavebeen updated for the correct types.
I've tried running Rspack and Rsbuild documentation with the upgraded
Rspress. Everything looks just fine!
Related Issue
#574
Checklist