📦 create-docusaurus

一个脚手架实用程序，帮助您立即建立一个功能的 Docusaurus 应用程序。

使用

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

name参数将被用作站点的路径，以及被创建应用的 package.json 中的name字段。它可以是绝对路径，也可以是相对于rootDir的路径。

template参数可以是下列参数之一:

• classic: 使用经典模板(推荐)
• facebook: 使用 Facebook/Meta 模板，其中包含一些特定于 Meta 的设置
• git repo URL(以https://或git@开头)，可以克隆到目标
• 相对于 CWD 的本地文件路径，其中包含要复制到目标的文件

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

警告

该命令最好在交互式 shell 中使用，以便所有功能都可用。

选项

-t, --typescript

当模板参数是可识别的名称时使用。目前，只有classic提供了 TypeScript 的变体。

-g, --git-strategy

当模板参数是一个 git repo 时使用。它必须是:

• 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选项仅在实际安装依赖项时有用。