Skip to main content

📦 create-docusaurus

高機能なDocusaurusアプリを即座にセットアップするための足がかりとなるユーティリティ

使い方​

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

引数nameは、サイトのパスとして、また作成されたアプリのpackage.jsonのnameフィールドとして使用されます。 絶対パスでも、rootDirからの相対パスでも構いません。

template は、次のいずれかになります。

  • classic：標準的なテンプレートを使用（推奨）
  • facebook：Facebook/Metaテンプレート（Meta専用設定を含む）を使用
  • 作成先にクローンできるGitリポジトリのURL（「https://」または「git@」から始まる）
  • 現在のディレクトリを起点とする、作成先にコピーされるファイルを含むローカルファイルパス

rootDirはサイトディレクトリへの絶対パスを解決するために利用されます。 初期値は現在のディレクトリです。

警告

このコマンドは、すべての機能が利用できるように、対話型シェルで使用することを推奨します。

Options​

-t, --typescript​

テンプレート引数が認識可能な名前である場合に使用されます。 現在、classicのみがTypeScriptの派生型を提供しています。

-g, --git-strategy​

テンプレートの引数がGitリポジトリの場合に使用します。 次のいずれかである必要があります。

  • deep：Gitの全履歴を保持
  • shallow：--depth=1をつけてクローン
  • copy：浅いクローンを作成するが、Gitリポジトリは作成しない
  • custom：カスタムのgit cloneコマンドを入力。 プロンプトを表示して尋ねます。 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オプションは、実際に依存関係をインストールするときにのみ有効です。