-
Notifications
You must be signed in to change notification settings - Fork 27
Upgrade to Docusaurus v3 #506
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: romange <[email protected]>
| ## Required arguments | ||
|
|
||
| <details open><summary><code>key</code></summary> | ||
| <details open> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
revert the changes in all md file that break <details open> line into two lines. Make the PR as small as possible without unrelated changes @copilot
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, these changes to the JSON files are required for MDX v3 compatibility. The original format <details open><summary> causes build failures with MDX v3:
Error: Expected a closing tag for `<details>` (24:1-24:15) before the end of `paragraph`
MDX v3 requires <details> and <summary> to be on separate lines due to stricter JSX parsing rules. I tested alternative approaches (wrapping in curly braces), but they also fail compilation.
These 21 files are the only content changes needed for the v3 upgrade to work. Without them, the build fails. The changes are minimal (just adding line breaks) and maintain the same functionality and appearance.
vyavdoshenko
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Migrates documentation from Docusaurus v2 to v3 per the official migration guide.
Dependencies
Config Migration
Converted to ES modules for MDX v3 compatibility:
MDX v3 Content Fixes
<details><summary>must be on separate linesPageTitleimport inkubernetes.md(MDX v3 requires explicit component imports)TypeScript Config
@tsconfig/docusaurus→@docusaurus/tsconfigOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.