📦 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@ 开头），可以克隆到目标位置
• 相对于 CWD 的本地文件路径，其中包含要复制到目标位置的文件

rootDir 将用于解析站点目录的绝对路径。默认值为 CWD。

警告

最好在交互式 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 中已存在的 lockfile（例如，如果您在现有项目中设置网站）
• 用于调用 create-docusaurus 的命令（例如，npm init、npx、yarn create、bunx 等）
• 交互式提示，以防所有启发式方法都不存在

-s, --skip-install

如果提供，Docusaurus 将不会在创建应用后自动安装依赖项。只有在您实际安装依赖项时，--package-manager 选项才有用。