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 to Docusaurus 3.0.1: Feature Enhancements and Dependency Upgrades #371

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ImmaZoni
Copy link
Contributor

Overview

This PR initiates the upgrade from Docusaurus 2.4.3 to 3.0.1, incorporating new features, breaking changes, and updates in dependencies.

Major Changes and Features

  • MDX v3 Integration: Shift from MDX v1 to v3.
  • React 18 Support: Upgrade to React 18.
  • TypeScript and ESM Configurations: Enhanced support.
  • Automatic JSX Runtime: Simplifies JSX usage.
  • Unlisted Content Options: New feature for content visibility.
  • Mermaid Diagrams: Support in Markdown.
  • Enhanced Syntax in Code Blocks: Improved functionality.
  • Admonition Syntax and Customization: More options.

Dependency Updates

  • Node.js: Upgraded to support Docusaurus 3.x.
  • React 18: Incorporates new features for enhanced UI responsiveness.
  • TypeScript: Updated for ESM compatibility.
  • Plugin and Dependency Updates: Ensures compatibility with the new Docusaurus framework.

Subtasks Checklist

  • Upgrade Node.js version.
  • Update Markdown for MDX v3.
  • Revise TypeScript for ESM.
  • Test React 18 integration.
  • Test Custom Components for React 18 Compatibility (Docker Generator, etc)
  • Enhance code blocks and syntax. (Optional)
  • Adapt new admonition features.
  • Test all updated plugins.
  • Fix Crowdin Export Bug for MDX v3 (Crowdin Exports Tabs HTML items indented in HTML causing rendering issues by markdown renderer)

Conclusion

For detailed information, refer to the Docusaurus 3.0 Release Notes and the Docusaurus v3 Migration Guide.

@ImmaZoni ImmaZoni added enhancement New feature or request help wanted Extra attention is needed do not merge breaking-change This label is for PR's that significantly change how our docs work labels Dec 14, 2023
@ImmaZoni ImmaZoni self-assigned this Dec 14, 2023
Copy link

netlify bot commented Dec 14, 2023

Deploy Preview for subspace-docs-staging failed.

Name Link
🔨 Latest commit 190d47a
🔍 Latest deploy log https://app.netlify.com/sites/subspace-docs-staging/deploys/657b6adc379e0600080f31c9

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change This label is for PR's that significantly change how our docs work do not merge enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant