概要

このドキュメントでは、既存のDocusaurus 1サイトをDocusaurus 2に移行する方法を説明します。

できる限り簡単に行えるように努めており、移行CLIを提供しています。

主な違い

Docusaurus 1は、サーバーサイドのテンプレートエンジンとしてReactを使用していますが、ブラウザでReactをロードしない、純粋なドキュメントサイトジェネレーターです。

Docusaurus 2は、根本から再構築され、ブラウザでReactのフルパワーを使用するシングルページアプリケーションを生成します。よりカスタマイズが可能になりましたが、Docusaurus 1の最も良い部分（始めやすさ、バージョン管理されたドキュメント、i18n）は保持されています。

さらに、Docusaurus 2は、高性能な静的サイトジェネレーターであり、一般的なコンテンツ駆動のWebサイト（ドキュメント、ブログ、製品ランディングページ、マーケティングページなど）を非常に迅速に作成するために使用できます。

私たちの主な焦点は、ドキュメントを適切に作成できるように支援することですが、Docusaurus 2は単なるReactアプリケーションであるため、あらゆる種類のWebサイトを構築できます。 Docusaurusは、ドキュメントWebサイトだけでなく、あらゆるWebサイトを構築するために使用できるようになりました。

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サイトには通常、/docsフォルダが/website内にあります。

v2に移行した後、/docsフォルダは好きな場所に配置できます。

移行プロセス

完全に機能するDocusaurus 2 Webサイトを取得するには、移行する必要があるものがいくつかあります

• パッケージ
• CLIコマンド
• サイト構成
• Markdownファイル
• サイドバーファイル
• ページ、コンポーネント、CSS
• バージョン管理されたドキュメント
• i18nサポート 🚧

自動移行プロセス

移行CLIが、移行の多くのことを処理します。

ただし、一部の部分は自動化が難しく、手動プロセスにフォールバックする必要があります。

注

移行CLIを実行し、手動移行プロセスのおかげで不足している部分を完了することをお勧めします。

手動移行プロセス

移行の一部（特にページ）は自動化できず、手動で移行する必要があります。

手動移行ガイドでは、すべての手動手順について説明します。

サポート

ご不明な点がございましたら、#migration-v1-to-v2 Discordチャンネルでお問い合わせください。

PRの移行に@slorberをタグ付けして、確認を依頼してください。

また、v1サイトの移行を支援してくれるボランティアもいます。

移行PRの例

基本的なDocusaurus v1サイトの移行がどのように行われるかの例として、Create React AppとFluxの移行PRを参照することをお勧めします。