grav

英文原文正文为项目原始 README（英文），本站后续会翻译为中文，当前仅剔除图片与无关章节并统一排版。

Grav

Grav 是一个快速、简单且灵活的基于文件的 Web 平台。无需任何安装。只需解压 ZIP 文件，您就可以立即开始使用。它遵循与其他扁平文件 CMS 平台类似的原则，但其设计理念与大多数平台不同。Grav 配备了强大的软件包管理系统，可以轻松安装和升级插件与主题，同时也能简单更新 Grav 本身。

Grav 的底层架构设计采用成熟且被认为是_最佳实践_的技术，以确保 Grav 简单易用且易于扩展。其中一些关键技术包括：

• Twig 模板：用于强大的用户界面控制
• Markdown：便于内容创建
• YAML：用于简单配置
• Parsedown：快速支持 Markdown 和 Markdown Extra
• Symfony 缓存：性能优化的后端层
• Pimple 依赖注入容器：用于可扩展性和可维护性
• Symfony 事件分发器：用于插件事件处理
• Symfony 控制台：命令行接口
• Gregwar 图像库：用于动态图像处理

系统要求

• PHP 8.3 或更高版本。请查看 必需模块列表
• 请查看 Apache 或 IIS 要求

文档

完整文档可在 learn.getgrav.org 获取。

快速开始

获取 Grav 的方式如下：

下载 Grav 软件包

您可以从 https://getgrav.org 的下载页面 下载一个已构建的包

使用 Composer

您可以使用以下命令创建一个包含最新稳定 Grav 版本的新项目：

composer create-project getgrav/grav ~/webroot/grav

来自 GitHub

1. 从 [https://github.com/getgrav/grav]() 克隆 Grav 仓库到服务器的 webroot 文件夹中，例如 ~/webroot/grav。启动 终端 或 控制台 并导航到 webroot 文件夹：

   cd ~/webroot
   git clone https://github.com/getgrav/grav.git

2. 通过使用 Grav CLI 应用程序 bin/grav 安装 插件 和 主题依赖 ：

   cd ~/webroot/grav
   bin/grav install

查看安装程序以获取更多信息。

添加功能

您可以从下载页面的适当标签手动下载插件或主题，但首选解决方案是使用Grav软件包管理器或 GPM：

bin/gpm index

这将显示所有可用的插件，然后你可以用以下方式安装一个或多个：

bin/gpm install <plugin/theme>

更新中

要更新 Grav，你应该使用 Grav 包管理器 或 GPM：

bin/gpm selfupgrade

要更新插件和主题：

bin/gpm update

从旧版本升级

从 Grav 1.x 迁移到 Grav 2.0？ Grav 2.0 是一个重大版本，基于 PHP 8.3 并拥有现代化核心，升级需要专门的迁移——仅使用 bin/gpm selfupgrade 并不能跨越 1.x → 2.x 的界限。在运行任何升级命令之前，请按照 getgrav.org/migrate-to-2 的分步指南操作。

在同一主版本内，bin/gpm selfupgrade 可处理点升级。以下指南涵盖 Grav 1.x 小版本之间的就地升级：

• 升级到 Grav 1.8
• 升级到 Grav 1.7
• 升级到 Grav 1.6
• 从 Grav 1.6 之前版本升级

贡献

我们欢迎对 Grav 的任何贡献，无论是与漏洞、语法相关，还是仅仅是建议或改进！请查阅 贡献指南 获取更多指导。

安全问题

如果您发现与 Grav 或其插件相关的潜在安全问题，请通过 contact@getgrav.org 发送电子邮件给核心团队，我们会尽快处理。

入门

• 什么是 Grav？
• 几秒钟内安装 Grav
• 了解配置
• 看看我们提供的免费模板
• 如果您有问题，请加入我们的Discord 聊天服务器！
• 玩得开心！

深入探索

• 看看我们的基础教程
• 深入了解更多高级功能
• 了解Grav CLI
• 查看Grav 食谱中的示例
• 更多精彩 Grav 内容

支持者

通过每月捐赠支持 Grav，帮助我们继续开发。[成为支持者]

许可证

查看许可证

运行测试

首先通过在 Grav 根目录下运行 composer install 来安装开发依赖。

然后 composer test 将运行单元测试，该测试在任何网站上都应该始终成功执行。Windows 用户应使用 composer test-windows 命令。你也可以运行单个单元测试文件，例如 composer test tests/unit/Grav/Common/AssetsTest.php

要运行 phpstan 测试，你应运行：

• composer phpstan 用于全局测试
• composer phpstan-framework 用于更严格的测试
• composer phpstan-plugins 用于测试所有已安装的插件