跳到主要内容

📦 create-docusaurus

一个用于快速搭建可用道格龙（Docusaurus）应用的脚手架工具。

用法​

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

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

template 参数可以是以下之一：

  • classic：使用经典模板（推荐）
  • facebook：使用 Facebook/Meta 模板，包含部分 Meta 专属配置
  • 一个 git 仓库地址（以 https:// 或 git@ 开头），会克隆到目标目录
  • 相对于当前工作目录的本地文件路径，包含要复制到目标的文件

rootDir 用于解析站点目录的绝对路径，默认为当前工作目录（CWD）。

注意

建议在交互式 shell 中运行此命令，以便使用全部功能。

选项​

-t, --typescript​

当 template 参数为已识别名称时可用。目前仅 classic 模板支持 TypeScript 变体。

-g, --git-strategy​

当 template 参数为 git 仓库时可用。可选值：

  • deep：保留完整 git 历史
  • shallow：使用 --depth=1 进行浅克隆
  • copy：浅克隆但不创建 git 仓库
  • custom：自定义 git clone 命令。会提示你输入，如 git clone --depth 10，我们会自动补全仓库地址和目标目录。

-p, --package-manager​

值应为 npm、yarn、pnpm 或 bun 之一。如果未显式指定，道格龙会根据以下方式自动推断：

  • 当前工作目录下已存在的 lockfile（如在已有项目中初始化网站）
  • 调用 create-docusaurus 的命令（如 npm init、npx、yarn create、bunx 等）
  • 若以上都无法判断，则会进行交互式询问

-s, --skip-install​

如指定该参数，道格龙不会在创建应用后自动安装依赖。--package-manager 选项仅在实际安装依赖时生效。