Kirby StaticBuilder 使用教程

Kirby StaticBuilder 使用教程

kirby-staticbuilderStatic HTML exporter for Kirby CMS (v2 only)项目地址:https://gitcode.com/gh_mirrors/ki/kirby-staticbuilder

项目介绍

Kirby StaticBuilder 是一个用于 Kirby CMS 的插件，旨在将网站导出为静态 HTML 文件、页面文件和资源文件。这个插件由 fvsch 开发，旨在满足比 @bastianallgeier 的 statify php 脚本更多的需求。目前，该插件已经可以编译页面并复制资产，并且可以防止将文件写入“static”文件夹之外的位置。

项目快速启动

安装

首先，你需要克隆项目到你的本地环境：

git clone https://github.com/fvsch/kirby-staticbuilder.git

然后，将插件文件夹复制到你的 Kirby 项目的 site/plugins 目录下。

配置

在你的 Kirby 项目中，找到 config.php 文件，并添加以下配置：

return [
    'staticbuilder' => [
        'outputDir' => 'static', // 输出目录
    ],
];

使用

在你的项目中，你可以通过以下代码触发静态文件的生成：

<?php
require __DIR__ . '/kirby/bootstrap.php';

$kirby = new Kirby([
    'roots' => [
        'index' => __DIR__,
    ],
]);

$staticBuilder = new StaticBuilder($kirby);
$staticBuilder->build();

应用案例和最佳实践

应用案例

一个典型的应用案例是将动态网站转换为静态网站，以便在 CDN 或 Netlify 等服务上进行托管。这样可以显著提高网站的加载速度，并减少潜在的安全漏洞。

最佳实践

1. 定期生成静态文件：建议定期生成静态文件，以确保内容的最新性。
2. 配置输出目录：根据项目需求配置输出目录，确保生成的文件可以正确部署。
3. 测试部署：在实际部署前，进行充分的测试，确保生成的静态文件在目标环境中正常工作。

典型生态项目

Kirby CMS

Kirby CMS 是一个灵活的内容管理系统，以其简单性和可扩展性而闻名。Kirby StaticBuilder 作为其插件之一，进一步扩展了其功能，使其能够生成静态网站。

Netlify

Netlify 是一个现代的静态网站托管服务，支持自动部署和持续集成。通过使用 Kirby StaticBuilder 生成的静态文件，可以轻松地将网站部署到 Netlify，享受其提供的各种服务和功能。

通过以上教程，你应该能够快速上手并使用 Kirby StaticBuilder 插件，将你的 Kirby CMS 网站转换为静态网站，并享受其带来的性能和安全优势。

kirby-staticbuilderStatic HTML exporter for Kirby CMS (v2 only)项目地址:https://gitcode.com/gh_mirrors/ki/kirby-staticbuilder