跳到主要内容

主题

本页 API 自 Halo 2.0.0 起可用。

activation()​

themeFinder.activation();

描述​

获取当前激活的主题。

参数​

无

返回值​

#ThemeVo

示例​

<div th:with="theme = ${themeFinder.activation()}">
  <h1 th:text="${theme.spec.displayName}"></h1>
  <p th:text="${theme.spec.version}"></p>
</div>

getByName(themeName)​

themeFinder.getByName(themeName);

描述​

根据主题的唯一标识 metadata.name 获取主题。

参数​

  • themeName:string - 主题名称

返回值​

#ThemeVo

示例​

<div th:with="theme = ${themeFinder.getByName('theme-foo')}">
  <h1 th:text="${theme.spec.displayName}"></h1>
  <p th:text="${theme.spec.version}"></p>
</div>

类型定义​

ThemeVo​

ThemeVo
{
  "metadata": {
    "name": "string", // 唯一标识
    "labels": {
      "additionalProp1": "string",
    },
    "annotations": {
      "additionalProp1": "string",
    },
    "creationTimestamp": "2022-11-20T14:44:58.984Z", // 创建时间
  },
  "spec": {
    "displayName": "string", // 显示名称
    "author": {
      // 作者相关信息
      "name": "string", // 作者名称
      "website": "string", // 作者网站
    },
    "description": "string", // 主题描述
    "logo": "string", // 主题 Logo
    "homepage": "string", // 主题主页地址
    "repo": "string", // 主题仓库地址
    "issues": "string", // 主题问题反馈地址
    "version": "string", // 主题版本
    "requires": "string", // 主题依赖 Halo 版本的设置
    "license": [
      // 主题许可信息
      {
        "name": "string", // 许可名称
        "url": "string", // 许可地址
      },
    ],
    "settingName": "string", // 主题设置表单名称
    "configMapName": "string", // 主题配置名称
    "customTemplates": {}, // 主题自定义模板设置
  },
  "config": {}, // 主题配置
}

其中：

  1. customTemplates：一般不会在模板引擎中使用，使用文档请参考：模板编写
  2. config：主题配置，使用文档请参考：设置选项

版本说明：spec.homepage 和 spec.license 自 Halo 2.7.0 起可用，spec.issues 自 Halo 2.15.0 起可用。