自动迁移

迁移 CLI 工具将自动将您的 v1 站点更新并迁移到 v2 版本。

信息

由于我们无法完全自动化迁移过程，所以您仍需要在使用自动迁移工具之后手动完成部分操作。

迁移 CLI 将更新：

• 站点配置（siteConfig.js 将更新至 docusaurus.config.js）
• package.json
• sidebars.json
• /docs
• /blog
• /static
• 若您的站点有多个版本，则还会更新 versioned_sidebar.json 和 /versioned_docs

要使用迁移 CLI，请遵循以下步骤：

1. 在使用迁移 CLI 前，确保 /docs、/blog、/static、sidebars.json、siteConfig.js 及 package.json 符合上方所示的目录结构。

2. 要开始迁移，请在正确的文件系统位置运行命令行工具：

# 迁移命令格式npx @docusaurus/migrate migrate <v1 网站目录> <v2 网站目录>
# 示例npx @docusaurus/migrate migrate ./v1-website ./v2-website

3. 要在本地预览您的全新站点，请前往 v2 网站目录并开启开发服务器。

cd ./v2-websiteyarn installyarn start

danger

迁移会 CLI 更新现有文件。 请务必先提交它们！

选项

您可以为迁移命令行工具添加额外参数来自动迁移 Markdown 内容及页面至 v2 版本。 但有可能您仍需要手动修改来达到最佳效果。

参数	描述
--mdx	自动将 Markdown 文件转换为 MDX 格式
--page	自动迁移页面

# 参数示例npx @docusaurus/migrate migrate --mdx --page ./v1-website ./v2-website

danger

页面及 MDX 迁移功能仍处于开发状态。

我们推荐您在自动迁移时先不添加以上参数并提交更改。之后，您可带上 --page 和 --mdx 参数再迁移一次。

这样，您可轻易发现并修复差异。