跳至主要内容
版本: 3.5.2

自动迁移

迁移 CLI 会自动将您的 v1 网站迁移到 v2 网站。

info

使用迁移 CLI 后,仍然需要手动操作,因为我们无法完全自动化迁移

迁移 CLI 会迁移

  • 站点配置(从 siteConfig.jsdocusaurus.config.js
  • package.json
  • sidebars.json
  • /docs
  • /blog
  • /static
  • versioned_sidebar.json/versioned_docs(如果您的网站使用版本控制)

要使用迁移 CLI,请按照以下步骤操作

  1. 在使用迁移 CLI 之前,请确保 /docs/blog/staticsidebars.jsonsiteConfig.jspackage.json 符合预期结构。

  2. 要迁移您的 v1 网站,请使用相应的路径运行迁移 CLI

# migration command format
npx @docusaurus/migrate migrate <v1 website directory> <desired v2 website directory>

# example
npx @docusaurus/migrate migrate ./v1-website ./v2-website
  1. 要查看您新的网站本地版本,请进入您的 v2 网站目录并启动开发服务器。
cd ./v2-website
npm install
npm start
danger

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

选项

您可以向迁移 CLI 添加选项标志,以自动将 Markdown 内容和页面迁移到 v2。您可能仍然需要进行一些手动更改才能达到预期结果。

名称描述
--mdx添加此标志以自动将 Markdown 转换为 MDX
--page添加此标志以自动迁移页面
# example using options
npx @docusaurus/migrate migrate --mdx --page ./v1-website ./v2-website
danger

页面和 MDX 的迁移仍在进行中。

建议您尝试在不使用这些选项的情况下运行页面,提交更改,然后使用 --page--mdx 选项再次运行迁移。

这样,您就可以轻松地检查和修复差异。