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

Docusaurus 3.5.x and MDX 3 migration #967

Merged
merged 3 commits into from
Oct 25, 2024

Conversation

lhotari
Copy link
Member

@lhotari lhotari commented Oct 25, 2024

Motivation

  • current website dependencies are outdated and need to be updated
  • this update enables to continue evolving the website without being blocked by old versions

Changes

  • followed https://docusaurus.io/docs/migration/v3 MDX v3 is more strict and that's why content updates were needed
  • replaced {@inject: ... } implementation with a Docusaurus markdown preprocessor since remark-linkify-regex no longer works since MDX v3 AST has changed.
  • Since validation is more strict, fixed a lot of content issues such as missing Tabs on a few pages.
  • Updated customized theme components by swizzling them again and diffing the customizations (upgrade instructions)

✅ Contribution Checklist

- followed https://docusaurus.io/docs/migration/v3
  MDX v3 is more strict and that's why content updates were needed
- enables to continue evolving the website without being blocked by old versions
@lhotari lhotari merged commit bae027a into apache:main Oct 25, 2024
2 of 3 checks passed
@lhotari
Copy link
Member Author

lhotari commented Oct 25, 2024

pushed 5805228 to fix a regression in the mobile / responsive layout for narrow display widths. The css class of the searchbox had changed.

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.

1 participant