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

Update Docusaurus to v3 #256

Merged
merged 14 commits into from
Nov 26, 2023
Merged

Update Docusaurus to v3 #256

merged 14 commits into from
Nov 26, 2023

Conversation

olijeffers0n
Copy link
Member

@olijeffers0n olijeffers0n commented Oct 10, 2023

Docusaurus v3 has been released bringing some slight Markdown changes. Namely, curly braces may need escaping within markdown and <! -- --> comments are not supported

@olijeffers0n olijeffers0n changed the title Update to Docusaurus to v3 Update Docusaurus to v3 Oct 10, 2023
@olijeffers0n
Copy link
Member Author

I have done some looking through the deployment and I believe everything is alright. If anyone can have a look through that would be appreciated 😄

@e-im
Copy link
Contributor

e-im commented Oct 31, 2023

3.0 is out now. Looking at the changes between this pr and the actual release it should just be a matter of updating the packages.

The primary change is an update from MDX v2 to the newly released MDX 3

This sounds pretty major (i.e. v1 -> v2), but its actually just a few very small changes, hence why it was added at the very end. We don't inferface with MDX directly hence no changes are needed. It's only new features

@olijeffers0n
Copy link
Member Author

Yep! Got the notification too. I marked it as draft when the RC came out. I’ll be looking to update in the coming days around Uni work. Someone poke me if i forget 😝

@e-im
Copy link
Contributor

e-im commented Oct 31, 2023

I had missed this initially but the patch for @docusaurus/core can also now be removed because loading typescript config files is now natively supported facebook/docusaurus#9317

# Conflicts:
#	docs/velocity/dev/getting-started/creating-your-first-plugin.mdx
@olijeffers0n
Copy link
Member Author

Okey, all patches are updated. Ready for reviewal

Copy link
Sponsor Contributor

@powercasgamer powercasgamer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Internationalization page should probably also be added to Velocity

@olijeffers0n olijeffers0n merged commit 7383a5c into main Nov 26, 2023
1 check passed
@olijeffers0n olijeffers0n deleted the update_docusaurus_v3 branch November 26, 2023 00:53
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.

None yet

4 participants