Resource 方法 on Hugo 中文文档

Colors

Fri, 02 Oct 2026 00:00:00 +0800

Colors 方法返回processable image（可处理的图像）中最主要颜色的切片，从最主要到最次要排序。

用法

该方法很快，但如果先把图像缩小，就可以从更小的资源中提取颜色，从而进一步提升性能。

Content

Fri, 02 Oct 2026 00:00:00 +0800

资源类型为 page 时，Resource 对象上的 Content 方法返回 template.HTML，否则返回 string。

assets/quotations/kipling.txt

He travels the fastest who travels alone.

要取得内容：

{{ with resources.Get "quotations/kipling.txt" }}
  {{ .Content }} → He travels the fastest who travels alone.
{{ end }}

要取得以字节为单位的大小：

Crop

Fri, 02 Oct 2026 00:00:00 +0800

Crop 方法依据给定的处理规格，从一张processable image（可处理的图像）返回新的资源。

用法

裁剪时必须在规格中同时给出宽度和高度（例如 200x200）。该方法不做任何缩放，只是按给出的尺寸以及锚点（如果有）截取图像的一个区域。

Data

Fri, 02 Oct 2026 00:00:00 +0800

Data 方法返回 resources.GetRemote、css.Build 与 js.Build 函数所产生资源的补充信息。

示例

{{ $url := "https://example.org/images/a.jpg" }}
{{ $opts := dict "responseHeaders" (slice "Server") }}
{{ with try (resources.GetRemote $url) }}
  {{ with .Err }}
    {{ errorf "%s" . }}
  {{ else with .Value }}
    {{ with .Data }}
      {{ .ContentLength }} → 42764
      {{ .ContentType }} → image/jpeg
      {{ .Headers }} → map[Server:[Netlify]]
      {{ .Status }} → 200 OK
      {{ .StatusCode }} → 200
      {{ .TransferEncoding }} → []
    {{ end }}
  {{ else }}
    {{ errorf "Unable to get remote resource %q" $url }}
  {{ end }}
{{ end }}

方法

在 Data 对象上使用这些方法。除非另有说明，这些方法适用于 resources.GetRemote 函数返回的资源。

Err

Fri, 02 Oct 2026 00:00:00 +0800

（0.141.0 起弃用） 请改用 try 语句。

Exif

Fri, 02 Oct 2026 00:00:00 +0800

（0.155.0 起弃用） 请改用 Meta 方法。

Fill

Fri, 02 Oct 2026 00:00:00 +0800

Fill 方法依据给定的处理规格，从一张processable image（可处理的图像）返回新的资源。

用法

填充时必须在规格中同时给出宽度和高度（例如 500x200）。Fill 会缩放图像以覆盖目标区域，再按给出的锚点裁掉溢出的像素，从而保持原始宽高比。

Filter

Fri, 02 Oct 2026 00:00:00 +0800

Filter 方法对一张processable image（可处理的图像）应用一个或多个图像滤镜后返回新的资源。

用法

用 Filter 方法应用模糊、锐化、灰度转换等效果。可以传入单个滤镜，也可以传入滤镜切片。传入切片时，Hugo 从左到右依次应用这些滤镜。

Fit

Fri, 02 Oct 2026 00:00:00 +0800

Fit 方法依据给定的处理规格，从一张processable image（可处理的图像）返回新的资源。

用法

适配时必须在规格中同时给出宽度和高度（例如 300x175）。Fit 会不断缩小图像直到它能放进指定尺寸，从而保持原始宽高比。与 Fill 或 Resize 不同，该方法绝不会放大图像；如果源图像小于目标尺寸，结果图像的尺寸与原图相同。

Height

Fri, 02 Oct 2026 00:00:00 +0800

调用 Height 方法之前，请先用 reflect.IsImageResourceWithMeta 函数确认 Hugo 能否确定图像尺寸。

{{ with resources.GetMatch "images/featured.*" }}
  {{ if reflect.IsImageResourceWithMeta . }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ else }}
    <img src="{{ .RelPermalink }}" alt="">
  {{ end }}
{{ end }}

MediaType

Fri, 02 Oct 2026 00:00:00 +0800

示例

{{ with resources.Get "images/a.jpg" }}
  {{ .MediaType.Type }} → image/jpeg
  {{ .MediaType.MainType }} → image
  {{ .MediaType.SubType }} → jpeg
  {{ .MediaType.Suffixes }} → [jpg jpeg jpe jif jfif]
  {{ .MediaType.FirstSuffix.Suffix }} → jpg
{{ end }}

方法

在 MediaType 对象上使用这些方法。

Type: (string) 返回媒体类型。
MainType: (string) 返回媒体类型的主类型。
SubType: (string) 返回媒体类型的子类型。
Suffixes: (slice) 返回媒体类型可能的文件后缀切片。
FirstSuffix.Suffix: (string) 返回媒体类型可能的文件后缀中的第一个。

Name

Fri, 02 Oct 2026 00:00:00 +0800

Resource 对象上的 Name 方法返回的值取决于资源类型。

全局资源

对于global resource（全局资源），Name 方法返回资源的路径，相对于 assets 目录。

assets/
└── images/
    └── Sunrise in Bryce Canyon.jpg

{{ with resources.Get "images/Sunrise in Bryce Canyon.jpg" }}
  {{ .Name }} → /images/Sunrise in Bryce Canyon.jpg
{{ end }}

页面资源

对于page resource（页面资源），如果在前置元数据的 resources 数组中创建了条目，Name 方法返回 name 参数的值。

Params

Fri, 02 Oct 2026 00:00:00 +0800

Params 方法用于page resource（页面资源），不适用于global resource（全局资源）或remote resource（远程资源）。

有如下内容结构：

content/
├── posts/
│   ├── cats/
│   │   ├── images/
│   │   │   └── a.jpg
│   │   └── index.md
│   └── _index.md
└── _index.md

以及如下前置元数据：

Permalink

Fri, 02 Oct 2026 00:00:00 +0800

Resource 对象上的 Permalink 方法把资源写入发布目录（通常是 public），并返回其permalink（永久链接）。

{{ with resources.Get "images/a.jpg" }}
  {{ .Permalink }} → https://example.org/images/a.jpg
{{ end }}

Process

Fri, 02 Oct 2026 00:00:00 +0800

Process 方法依据给定的处理规格，从一张processable image（可处理的图像）返回新的资源。

用法

这个方法功能全面，能在一条规格字符串中完成完整的图像变换，包括缩放、裁剪、旋转与格式转换。与 Resize、Crop 这类专用方法不同，如果要改变图像尺寸，你必须在规格中显式写出 action。

Publish

Fri, 02 Oct 2026 00:00:00 +0800

Resource 对象上的 Publish 方法把给定资源写入 publishDir。

下例用 resources.FromString 从字符串创建资源，然后发布它：

layouts/baseof.html

{{ $content := printf "Contact: mailto:%s\n" site.Params.email }}
{{ with resources.FromString ".well-known/security.txt" $content }}
  {{ .Publish }}
{{ end }}

Permalink 与 RelPermalink 方法也会发布资源。Publish 是一个不带返回值的便捷发布方法。例如，下面这样写：

RelPermalink

Fri, 02 Oct 2026 00:00:00 +0800

Resource 对象上的 Permalink 方法把资源写入发布目录（通常是 public），并返回其relative permalink（相对永久链接）。

{{ with resources.Get "images/a.jpg" }}
  {{ .RelPermalink }} → /images/a.jpg
{{ end }}

Resize

Fri, 02 Oct 2026 00:00:00 +0800

Resize 方法依据给定的处理规格，从一张processable image（可处理的图像）返回新的资源。

用法

按给定的处理规格缩放图像。等比缩放时可以只指定宽度（如 300x），也可以只指定高度（如 x150）。

ResourceType

Fri, 02 Oct 2026 00:00:00 +0800

常见的资源类型包括 audio、image、text 和 video。

{{ with resources.Get "image/a.jpg" }}
  {{ .ResourceType }} → image
  {{ .MediaType.MainType }} → image
{{ end }}

处理内容文件时，资源类型为 page。

content/
├── lessons/
│   ├── lesson-1/
│   │   ├── _objectives.md  <-- resource type = page
│   │   ├── _topics.md      <-- resource type = page
│   │   ├── _example.jpg    <-- resource type = image
│   │   └── index.md
│   └── _index.md
└── _index.md

用上面的结构，可以遍历类型为 page 的页面资源来构建内容：

Title

Fri, 02 Oct 2026 00:00:00 +0800

Resource 对象上的 Title 方法返回的值取决于资源类型。

全局资源

对于global resource（全局资源），Title 方法返回资源的路径，相对于 assets 目录。

assets/
└── images/
    └── Sunrise in Bryce Canyon.jpg

{{ with resources.Get "images/Sunrise in Bryce Canyon.jpg" }}
  {{ .Title }} → /images/Sunrise in Bryce Canyon.jpg
{{ end }}

页面资源

对于page resource（页面资源），如果在前置元数据的 resources 数组中创建了条目，Title 方法返回 title 参数的值。

Width

Fri, 02 Oct 2026 00:00:00 +0800

调用 Width 方法之前，请先用 reflect.IsImageResourceWithMeta 函数确认 Hugo 能否确定图像尺寸。

{{ with resources.GetMatch "images/featured.*" }}
  {{ if reflect.IsImageResourceWithMeta . }}
    <img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ else }}
    <img src="{{ .RelPermalink }}" alt="">
  {{ end }}
{{ end }}