Skip to main content

模板

¥Templates

Strapi 5 中的模板是独立的、预制的 Strapi 应用,专为特定用例而设计。

¥Templates in Strapi 5 are standalone, pre-made Strapi applications designed for specific use cases.

Strapi 5 模板是包含你在典型的 Strapi 应用中找到的所有文件和文件夹的文件夹(参见 项目结构)。

¥Strapi 5 templates are folders that include all files and folders that you would find in a typical Strapi application (see project structure).

使用模板

¥Using a template

要基于模板创建新的 Strapi 项目,请运行以下命令:

¥To create a new Strapi project based on a template, run the following command:

yarn create strapi-app my-project --template <template-name-or-url>

除了必需的 --template 参数之外,你还可以传递可选的 --template-path--template-branch 选项以更精确地定义要使用的模板。

¥In addition to the mandatory --template parameter, you can pass the optional --template-path and --template-branch options to more precisely define the template to use.

下表列出了定义要使用哪个模板的所有可能方法:

¥The following table lists all the possible ways to define which template to use:

语法描述
--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

创建模板

¥Creating a template

创建 Strapi 5 模板与创建 Strapi 应用一样简单。创建应用(参见 CLI 安装),生成的包含 Strapi 5 应用的文件夹可用作模板。然后,你可以在创建新的 Strapi 5 应用以将其用作模板时将其传递给 --template 标志。

¥Creating a Strapi 5 template is as simple as creating a Strapi application. Create the application (see CLI installation) and the generated folder containing your Strapi 5 application can serve as a template. You can then pass it to the --template flag when creating a new Strapi 5 application to use it as a template.

模板的示例是 Strapi 维护的 website 模板

¥An example of what a template could look like is the Strapi-maintained website template.