Skip to content

Bump UI frameworks (Docusaurus, MDX, React) #2722

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

Merged
merged 14 commits into from
May 2, 2024
Merged

Conversation

omacranger
Copy link
Member

@omacranger omacranger commented Apr 5, 2024

Description

This bumps the various UI frameworks used in sauce-docs, including Docusaurus, MDX to v3, React to v18, etc.

Motivation and Context

Our deps were pretty out of date and lacked features for dynamic variables & partials that newer MDX versions support.

Unfortunately, MDX2 and up is a breaking change.

Included in the PR are fixes for the following:

  • Whitespace fixes across files to allow the interleaving feature to work as intended
  • Escaping of any variable-like values ({var} is now parsed as a JS variable, and needs to be escaped like \{var} to have it render as they previously did)
  • MDX2 and up allow using markdown inside of react components, unfortunately they also insert <p> tags whenever there is a newline after a component. I've included a plugin here to revert this behavior as it would break a lot of styles on the docs site across many pages

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation fix (typos, incorrect content, missing content, etc.)

Logan Graham added 2 commits April 5, 2024 17:04
@omacranger omacranger requested review from discombobulateme, a team and rick-bt as code owners April 5, 2024 21:08
Copy link

github-actions bot commented Apr 5, 2024

Deploy preview ready for 2722!
https://docs.dev.saucelabs.net
built from 43a6bac

Copy link

github-actions bot commented Apr 5, 2024

Deploy preview ready for 2722!
https://docs.dev.saucelabs.net
built from a0b92ec

Copy link

github-actions bot commented Apr 5, 2024

Deploy preview ready for 2722!
https://docs.dev.saucelabs.net
built from 2e96b54

Copy link

github-actions bot commented Apr 5, 2024

Deploy preview ready for 2722!
https://docs.dev.saucelabs.net
built from a4c9301

Copy link

github-actions bot commented Apr 5, 2024

Deploy preview ready for 2722!
https://docs.dev.saucelabs.net
built from 7e2256c

@omacranger omacranger changed the title Bump Docusaurus, mdx Bump UI frameworks (Docusaurus, MDX, React) Apr 5, 2024
@discombobulateme discombobulateme merged commit 7456ea9 into main May 2, 2024
6 of 7 checks passed
@discombobulateme discombobulateme deleted the feat/package-bumps branch May 2, 2024 17:20
@discombobulateme discombobulateme mentioned this pull request May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants