docusaurus-v2-to-v3-migration
用于将Docusaurus项目从v2迁移到v3
📖 中文导读:用于将Docusaurus项目从v2迁移到v3 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
name: docusaurus-v2-to-v3-migration
IMPORTANT: Keep description on ONE line for Claude Code compatibility
prettier-ignore
description: Use when migrating Docusaurus projects from v2 to v3
Docusaurus V2 To V3 Migration
Quick Start
{
"@docusaurus/core": "^3.0.0",
"@mdx-js/react": "^3.0.0",
"prism-react-renderer": "^2.1.0",
"react": "^18.2.0"
}
Core Principles
- MDX v1 → v3: Main challenge - escape
{and<characters or wrap in code blocks - Node.js >=18.0: Required for Docusaurus v3
- React 18: Breaking changes may affect custom components
Migration Steps
- Pre-check: Run
npx docusaurus-mdx-checkerto identify MDX issues - Update deps: Upgrade all @docusaurus packages, React, MDX, prism-react-renderer
- Fix MDX: Escape bare
{<characters, convert GFM autolinks, use code fences - Update config: Replace
@tsconfig/docusauruswith@docusaurus/tsconfig, update Prism imports - Test: Run
npm startthennpm run build
Reference Files
- breaking-changes.md - Complete migration guide with examples