跳到主要内容

概述

本文档指导您将现有的道格龙（Docusaurus）1 站点迁移到道格龙（Docusaurus）2。

我们努力使这个过程尽可能简单，并提供了迁移 CLI。

主要差异​

道格龙（Docusaurus）1 是一个纯文档站点生成器，使用 React 作为服务器端模板引擎，但不在浏览器中加载 React。

道格龙（Docusaurus）2 从头开始重建，生成单页应用程序，在浏览器中充分利用 React 的强大功能。它允许更多自定义性，同时保留了道格龙（Docusaurus）1 的最佳部分 - 易于上手、版本化文档和国际化。

除此之外，道格龙（Docusaurus）2 是一个高性能的静态站点生成器，可用于极其快速地创建常见的内容驱动网站（例如文档、博客、产品落地页和营销页面等）。

虽然我们的主要重点仍然是帮助您正确和完善地处理文档，但可以使用道格龙（Docusaurus）2 构建任何类型的网站，因为它只是一个 React 应用程序。道格龙（Docusaurus）现在可用于构建任何网站，而不仅仅是文档网站。

道格龙（Docusaurus）1 结构​

您的道格龙（Docusaurus）1 站点应具有以下结构：

├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

道格龙（Docusaurus）2 结构​

迁移后，您的道格龙（Docusaurus）2 站点可能如下所示：

├── docs
└── website
    ├── blog
    ├── src
    │   ├── components
    │   ├── css
    │   └── pages
    ├── static
    ├── package.json
    ├── sidebars.json
    ├── docusaurus.config.js
信息

此迁移不会更改 /docs 文件夹位置，但道格龙（Docusaurus）v2 站点通常在 /website 内有 /docs 文件夹

迁移到 v2 后，您可以将 /docs 文件夹放在任何您想要的位置。

迁移过程​

要获得功能完整的道格龙（Docusaurus）2 网站，需要迁移多个部分：

  • 包
  • CLI 命令
  • 站点配置
  • Markdown 文件
  • 侧边栏文件
  • 页面、组件和 CSS
  • 版本化文档
  • 国际化支持 🚧

自动化迁移过程​

迁移 CLI 将为您处理迁移的许多部分。

但是，某些部分无法轻易自动化，您将不得不回退到手动过程。

备注

我们建议运行迁移 CLI，并通过手动迁移过程完成缺失的部分。

手动迁移过程​

迁移的某些部分无法自动化（特别是页面），您将不得不手动迁移它们。

手动迁移指南 将为您提供所有手动步骤。

支持​

如有任何问题，您可以在 #migration-v1-to-v2 Discord 频道 中询问。

如果您希望我们查看，请随时在任何迁移 PR 中标记 @slorber。

我们还有志愿者愿意帮助您迁移 v1 站点。

迁移 PR 示例​

您可能想参考我们为 Create React App 和 Flux 的迁移 PR 作为基本道格龙（Docusaurus）v1 站点迁移的示例。

最后于 更新