模板
页面摘要: 模板是完整的 Strapi 应用,可通过
--template、--template-path和--template-branch等 CLI 参数引导创建新项目。本文档中的说明涵盖从 GitHub 引用模板,以及将任意 Strapi 项目转变为可复用模板的方法。
Strapi 5 中的模板是独立的、预置的 Strapi 应用程序,专为特定用例设计。
Strapi 5 模板是包含典型 Strapi 应用程序中所有文件与文件夹的目录(参见项目结构)。
使用模板
要基于模板创建新的 Strapi 项目,请运行以下命令:
Yarn
yarn create strapi-app my-project --template <template-name-or-url>
NPM
npx create-strapi-app@latest my-project --template <template-name-or-url>
除必需的 --template 参数外,你还可以传入可选的 --template-path 和 --template-branch 选项,以更精确地定义要使用的模板。
下表列出了定义要使用模板的所有可能方式:
| 语法 | 说明 |
|---|---|
--template website | 使用某个 Strapi 维护的模板,以其(文件夹)名称调用。 |
--template strapi/strapi | 使用模板的 GitHub 仓库简写。 将使用默认仓库分支。 |
--template strapi/strapi/some/sub/path | 使用模板的 GitHub 仓库简写并指定子路径。 将使用默认仓库分支。 |
--template strapi/strapi--template-branch=xxx--template-path=some/sub/path | 最详细的写法,显式定义模板分支和子路径。 |
--template https://github.com/owner/some-template-repo | 使用完整的仓库 URL。 将使用默认仓库分支。 |
--template https://github.com/owner/some-template-repo --template-branch=xxx --template-path=sub/path | 使用完整仓库 URL,并为模板同时指定分支和子路径。 |
--template https://github.com/strapi/strapi/tree/branch/sub/path | 直接使用仓库、分支和子路径。 ⚠️ 警告:这不适用于包含 / 的分支名。在这种情况下,最好显式定义 --template-branch 和 --template-path。 |
创建模板
创建 Strapi 5 模板与创建 Strapi 应用程序一样简单。创建应用程序(参见CLI 安装),生成的包含 Strapi 5 应用程序的文件夹即可作为模板。之后,在创建新的 Strapi 5 应用程序时,你可以将其传给 --template 参数,将其用作模板。
模板的一个示例是 Strapi 维护的 website 模板。