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

Upgrade to Docusaurus v3 #566

Closed
diwakergupta opened this issue Nov 29, 2023 · 1 comment · Fixed by #589
Closed

Upgrade to Docusaurus v3 #566

diwakergupta opened this issue Nov 29, 2023 · 1 comment · Fixed by #589
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@diwakergupta
Copy link
Member

Not urgent, just filing for tracking.

Docusaurus v3 was released last month and v2 is now in maintenance mode. They recommend upgrading to v3 by January 2024.

The upgrade guide seems mostly straight-forward.

I started making the changes just to get a sense of scope. Right now the primary blocker is the openapi plugin, which does have an approved (though not yet merged) PR for v3 support.

Once that is merged, hopefully this should be an easy lift.

@diwakergupta diwakergupta added enhancement New feature or request help wanted Extra attention is needed labels Nov 29, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Hiro Docs Nov 29, 2023
@diwakergupta
Copy link
Member Author

Quick update here: docusaurus has announced v2.x is no longer supported, released 3.0.1. The openapi plugin has also been updated, so that's no longer a blocker.

At this point, the only blocker is actual Markdown changes that break because of the switch from MDX1 to MDX3. This is in line with what they say: https://docusaurus.io/docs/migration/v3

The main breaking change is the upgrade from MDX v1 to MDX v3

Specifically, a bunch of stuff in _commands.md now breaks due to the problems described here: https://docusaurus.io/docs/migration/v3#common-mdx-problems

Basically, bad usages of { and < that now need to be escaped properly.

Addressing this properly likely requires an update to stacks.js as well, I'll see if I can generate a PR easily. FYI @janniks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
No open projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant