跳至主要內容
版本:3.5.2

自動化移轉

移轉 CLI 會自動將您的 v1 網站移轉至 v2 網站。

訊息

使用移轉 CLI 後,仍需要進行手動處理,因為我們無法自動完成完整移轉

移轉 CLI 會移轉

  • 網站組態(從 siteConfig.js 變成 docusaurus.config.js
  • package.json
  • sidebars.json
  • /docs
  • /blog
  • /static
  • versioned_sidebar.json/versioned_docs(如果您的網站使用版本控制)

如需使用移轉 CLI,請按照下列步驟執行

  1. 在使用移轉 CLI 前,請確保 /docs/blog/staticsidebars.jsonsiteConfig.jspackage.json 符合預期的結構。

  2. 如需移轉您的 v1 網站,請針對適當的檔案系統路徑執行移轉 CLI

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

# example
npx @docusaurus/migrate migrate ./v1-website ./v2-website
  1. 如需在本地檢視你的新網站,請進入你的 v2 網站目錄並啟動你的開發伺服器。
cd ./v2-website
npm install
npm 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` 選項執行移轉。

這樣一來,你可以輕鬆地檢查和修復差異。