📦 创建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)。
warning
此命令最好在交互式 shell 中使用,以便所有功能都可用。
选项
-t, --typescript
当模板参数是已识别的名称时使用。目前,只有classic提供了TypeScript变体。
-g, --git-strategy
当模板参数是一个git仓库时使用。它需要是以下之一:
deep: 保留完整的 git 历史记录shallow: 使用--depth=1进行克隆copy: 进行浅克隆,但不会创建 git 仓库custom: 输入您的自定义 git clone 命令。我们会提示您输入。您可以编写类似git clone --depth 10的内容,我们会附加仓库 URL 和目标目录。
-p, --package-manager
值应为 npm、yarn 或 pnpm 之一。如果未明确提供,Docusaurus 将根据以下内容推断:
- CWD 中已经存在的 lockfile(例如,如果您正在现有项目中设置网站)
 - 用于调用
create-docusaurus的命令(例如npm init、npx、yarn create等) - 交互式提示,以防所有启发式方法都不存在
 
-s, --skip-install
如果提供,Docusaurus 在创建应用程序后将不会自动安装依赖项。--package-manager 选项仅在您实际安装依赖项时有用。