📦 create-docusaurus

機能的なDocusaurusアプリをすぐにセットアップするための足場ユーティリティです。

使用方法

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

name引数は、サイトのパスと、作成されたアプリのpackage.jsonのnameフィールドとして使用されます。絶対パスまたはrootDirを基準とした相対パスにすることができます。

template引数は、以下のいずれかになります。

• classic: クラシックテンプレートを使用します（推奨）
• facebook: Facebook/Metaテンプレートを使用します。Meta固有の設定が含まれています。
• https://またはgit@で始まるGitリポジトリのURL。クローンを作成できます。
• CWDを基準としたローカルファイルパス。ファイルがコピーされます。

rootDirは、サイトディレクトリへの絶対パスの解決に使用されます。デフォルトはCWDです。

警告

このコマンドは、すべての機能を使用するために、対話型シェルで使用することをお勧めします。

オプション

-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オプションは、依存関係を実際にインストールする場合にのみ役立ちます。