バージョン: 3.5.2

自動移行

移行CLIは、v1 Webサイトをv2 Webサイトに自動的に移行します。

情報

完全な移行を自動化することはできないため、移行CLIを使用した後も手作業が必要です。

移行CLIは以下を移行します

サイト設定 (siteConfig.js から docusaurus.config.js へ)
package.json
sidebars.json
/docs
/blog
/static
サイトでバージョン管理を使用している場合は、versioned_sidebar.json と /versioned_docs

移行CLIを使用するには、次の手順に従います

移行CLIを使用する前に、/docs、/blog、/static、sidebars.json、siteConfig.js、package.json が想定される構造に従っていることを確認してください。
v1 Webサイトを移行するには、適切なファイルシステムパスを指定して移行CLIを実行します

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

# example
npx @docusaurus/migrate migrate ./v1-website ./v2-website

新しいWebサイトをローカルで表示するには、v2 Webサイトのディレクトリに移動して、開発サーバーを起動します。

npm
Yarn
pnpm

cd ./v2-website
npm install
npm start

cd ./v2-website
yarn install
yarn start

cd ./v2-website
pnpm install
pnpm start

危険

移行CLIは既存のファイルを更新します。必ず最初にコミットしてください！

オプション

移行CLIにオプションフラグを追加して、Markdownコンテンツとページをv2に自動的に移行できます。目的の結果を得るには、手動で変更を加える必要がある場合があります。

名前	説明
`--mdx`	このフラグを追加すると、MarkdownがMDXに自動的に変換されます
`--page`	このフラグを追加すると、ページが自動的に移行されます

# example using options
npx @docusaurus/migrate migrate --mdx --page ./v1-website ./v2-website

危険

ページとMDXの移行はまだ進行中です。

これらのオプションなしでページを実行してみて、コミットしてから、--page および --mdx オプションを指定して移行を再実行することをお勧めします。

こうすることで、差分を簡単に検査して修正できます。

オプション​

オプション