跳到主要内容
版本：3.8.1

📦 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​

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

-g, --git-strategy​

当 template 参数是 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 选项仅在您实际安装依赖时才有用。