Grav - 主题基础知识

主题控制 Grav 站点的外观。Grav 中的主题是使用强大的Twig 模板引擎构建的。

内容页面和树枝模板

您创建的页面通过名称或通过设置页面的模板标头变量来引用特定的模板文件。建议使用页面名称以简化维护。

安装 Grav Base 包后，您将在 user/pages/01.home 文件夹中找到defauld.md文件。文件的名称（即default）告诉Grav该页面应该使用放置在themes/<mytheme>/templates文件夹内的twig模板default.html.twig来呈现。

例如，如果您有一个名为contact.md 的文件，它将使用 twig 模板呈现为theme/<mytheme>/templates/contact.html.twig。

主题组织

在下面的部分中，我们将讨论主题组织，即它的定义、配置等。

定义和配置

有关主题的信息将在user/themes/antimatter/blueprints.yaml文件中定义，并且可以选择提供在管理面板中使用的表单定义。您将在Antimatter 主题的user/themes/antimatter/blueprints.yaml文件中看到以下内容。

name: Antimatter
version: 1.6.0
description: "Antimatter is the default theme included with **Grav**"
icon: empire
author:
   name: Team Grav
   email: devs@getgrav.org
   url: http://getgrav.org
homepage: https://github.com/getgrav/grav-theme-antimatter
demo: http://demo.getgrav.org/blog-skeleton
keywords: antimatter, theme, core, modern, fast, responsive, html5, css3
bugs: https://github.com/getgrav/grav-theme-antimatter/issues
license: MIT

form:
   validation: loose
   fields:
      dropdown.enabled:
         type: toggle
         label: Dropdown in navbar
         highlight: 1
         default: 1
         options:
            1: Enabled
            0: Disabled
         validate:
            type: bool

为了使用主题配置选项，您需要在名为user/themes/<mytheme>/<mytheme>.yaml 的文件中提供默认设置。

例子

enable: true

主题和插件事件

主题通过插件架构与 Grav 交互的能力是 Grav 的另一个强大功能。要实现此目的，只需创建user/themes/<mytheme>/<mytheme>.php（例如，默认 Antimatter 主题的antimatter.php）文件并使用以下格式。

<?php
namespace Grav\Theme;

use Grav\Common\Theme;

class MyTheme extends Theme {
   public static function getSubscribedEvents() {
      return [
         'onThemeInitialized' => ['onThemeInitialized', 0]
      ];
   }
   public function onThemeInitialized() {
      if ($this->isAdmin()) {
         $this->active = false;
         return;
      }
      
      $this->enable([
         'onTwigSiteVariables' => ['onTwigSiteVariables', 0]
      ]);
   }
   public function onTwigSiteVariables() {
      $this->grav['assets']
         ->addCss('plugin://css/mytheme-core.css')
         ->addCss('plugin://css/mytheme-custom.css');

      $this->grav['assets']
         ->add('jquery', 101)
         ->addJs('theme://js/jquery.myscript.min.js');
   }
}

模板

Grav 主题的结构没有固定的规则，除了每个页面类型内容的 templates/ 文件夹中必须有关联的 twig 模板。

由于页面内容和树枝模板之间的紧密耦合，最好基于下载页面中提供的骨架包创建通用主题。

假设您想在主题中支持模块化模板，您必须创建module/文件夹并在其中存储 twig 模板文件。如果您想支持表单，那么您应该创建form/文件夹并在其中存储表单模板。

蓝图

要为每个模板文件定义选项和配置表单，请使用blueprint/文件夹。这些不能通过管理员面板进行编辑，并且可以选择使用。该主题功能齐全，无需蓝图文件夹。

SCSS/LESS/CSS

如果你想使用 SASS 或 LESS 开发网站，那么你必须在user/themes/<mytheme>/scss/中创建子文件夹，如果你想要 LESS 和 css/ 文件夹，则必须在less/ 中创建子文件夹。

对于从 SASS 或 LESS 编译的自动生成的文件，使用css-compiled/文件夹。在 Antimatter 主题中，使用了 SASS 的scss变体。

请按照以下步骤在您的计算机中安装 SASS。

  • 在主题的根目录中，键入下面给出的命令来执行 scss shell 脚本。

$ ./scss.sh
  • 输入以下命令直接运行它。
$ scss --sourcemap --watch scss:css-compiled

css -compiled/将包含所有已编译的 scss 文件，并且 css 文件将在您的主题内生成。

其他文件夹

建议在user/themes/<mytheme>/文件夹中为主题中使用的任何图像、字体和 JavaScript 文件创建单独的images/、fonts/和js/文件夹。

主题示例

我们到目前为止讨论的Antimatter主题的整体文件夹结构如下所示。

Grav 主题基础知识