Skip to main content
Version: 3.6.3

概述

本文档指导您如何将现有的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
info

此迁移不会更改/docs文件夹的位置,但Docusaurus v2站点通常将/docs文件夹放在/website

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

迁移过程

要迁移多个内容以获得一个功能齐全的Docusaurus 2网站:

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

自动化迁移过程

迁移 CLI 将为您处理迁移的许多事项。

然而,有些部分不容易自动化,你将不得不退回到手动过程。

note

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

手动迁移过程

迁移的某些部分无法自动化(特别是页面),您将需要手动迁移它们。

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

支持

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

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

我们也有志愿者愿意帮助您迁移您的v1站点

示例迁移PRs

您可能希望参考我们的迁移PRs,例如Create React AppFlux,作为如何为基本的Docusaurus v1站点进行迁移的示例。