概覽

本篇文件提供現有 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

訊息

移轉並未變更 /doc 資料夾位置，但 Docusaurus v2 網站通常會將 /docs 資料夾置於 /website 中。

移轉至 v2 後，您可以自由地將 /docs 資料夾放置在任何想要的位置。

移轉流程

需移轉多個部分以取得功能完整的 Docusaurus 2 網站。

• 套件
• CLI 指令
• 網站設定
• Markdown 檔案
• 側邊欄檔案
• 頁面、元件和 CSS
• 版本化文件
• i18n 支援 🚧

自動化移轉流程

移轉 CLI 會幫您處理許多移轉事宜。

然而，有些部分無法輕易地自動化，因此您必須改用手動流程。

附註

我們建議您執行移轉 CLI，並透過手動移轉流程完成遺漏的部分。

手動移轉流程

移轉的某些部分無法自動化（尤其是頁面），因此您必須手動移轉。

手動遷移指南 將提供所有手動步驟。

支援

如有任何問題，請在 #migration-v1-to-v2 Discord 頻道中詢問。

隨時標記 @slorber，了解任何遷移公關，讓我們了解現況。

我們也有志工願意 協助您遷移您的 v1 網站。

遷移公關範例

您可能想參考我們的遷移公關，以了解如何進行基本 Docusaurus v1 網站的遷移，相關範例包括：Create React App 和 Flux。