跳到主要內容
版本： 3.5.2

📦 create-docusaurus

一個協助你快速建立運作中的 Docusaurus 應用程式的建構公用程式。

用法​

npx create-docusaurus@latest [name] [template] [rootDir]

name 引數將用於作為網站的路徑，以及建立的應用程式內的 name 欄位在 package.json 中。它可以是絕對路徑，或者相對於 rootDir 的相對路徑。

template 引數可以是下列其中之一

  • classic：使用一般範本（建議使用）
  • facebook：使用 Facebook/Meta 範本，其中包含一些特定於 Meta 的設定
  • 開始於 https:// 或 git@ 的 git 儲存庫 URL，可以用來複製至目的地
  • 相對於目前的執行目錄的本機檔案路徑，它包含要複製至目標位置的檔案

rootDir 將用於回傳網站目錄的絕對路徑。預設值為目前的執行目錄。

警告

這個指令最好用於互動式的 shell 中，才能使用所有功能。

選項​

-t, --typescript​

當範本引數為已識別的名稱時使用。目前，只有 classic 提供 TypeScript 變異項。

-g, --git-strategy​

當範本引數為 git 儲存庫時使用。它必為下列其中一個：

  • deep：保留完整的 git 歷史記錄
  • shallow：使用 --depth=1 克隆
  • copy：執行淺層複製，但不會建立 git 儲存庫
  • custom：輸入您自訂的 git 克隆指令。我們會提示您輸入。您可以撰寫類似 git clone --depth 10 的內容，我們會附加存放庫的 URL 和目標目錄。

-p, --package-manager​

值應為 npm、yarn、pnpm 或 bun 之一。如果未明確提供，Docusaurus 會根據下列條件推斷一個：

  • 已存在於 CWD 中的鎖定檔（例如：如果您在現有專案中設定網站）
  • 用於呼叫 create-docusaurus 的指令（例如：npm init、npx、yarn create、bunx 等）
  • 互動提示，萬一所有啟發式都未存在

-s, --skip-install​

如果提供，Docusaurus 不會在建立應用程式後自動安裝依賴項。只有在您實際安裝依賴項時，--package-manager 選項才會有效。