函数 | Hugo 框架

cast

使用这些函数将值从一种数据类型转换为另一种数据类型。

cast.ToFloat (float): 将值转换为十进制浮点数（以 10 为底）。
cast.ToInt (int): 将值转换为十进制整数（以 10 为底）。
cast.ToString (string): 将值转换为字符串。

collections

使用这些函数来处理数组、切片、映射和页面集合。

collections.After (after): 将数组切片到第 N 个项目之后的项目。
collections.Append (append): 将一个或多个元素附加到切片并返回结果切片。
collections.Apply (apply): 返回一个新的集合，其中每个元素都由给定函数转换。
collections.Complement (complement): 返回最后一个集合中不在任何其他集合中的元素。
collections.Delimit (delimit): 循环遍历任何数组、切片或映射，并返回一个字符串，其中包含所有以分隔符分隔的值。
collections.Dictionary (dict): 返回由给定键值对组成的映射。
collections.First (first): 返回给定的集合，限制为前 N 个元素。
collections.Group (group): 按给定键对给定的页面集合进行分组。
collections.In (in): 报告给定值是否为给定集合的成员。
collections.Index (index): 返回与给定键或多个键关联的对象、元素或值。
collections.Intersect (intersect): 返回两个数组或切片的公共元素，其顺序与第一个数组相同。
collections.IsSet (isset): 报告键是否存在于集合中。
collections.KeyVals (keyVals): 返回 KeyVals 结构。
collections.Last (last): 返回给定的集合，限制为最后 N 个元素。
collections.Merge (merge): 返回合并两个或多个映射的结果。
collections.NewScratch (newScratch): 返回一个局部范围的“暂存区”，用于存储和操作数据。
collections.Querify (querify): 返回一个 URL 查询字符串，该字符串由给定的键值对组成，经过编码并按键排序。
collections.Reverse: 反转集合的顺序。
collections.Seq (seq): 返回一个整数切片。
collections.Shuffle (shuffle): 返回给定数组或切片的随机排列。
collections.Slice (slice): 返回由给定值组成的切片。
collections.Sort (sort): 对切片、映射和页面集合进行排序。
collections.SymDiff (symdiff): 返回两个集合的对称差。
collections.Union (union): 给定两个数组或切片，返回一个新数组，其中包含属于一个或两个数组/切片的元素。
collections.Uniq (uniq): 返回给定的集合，删除重复元素。
collections.Where (where): 返回给定的集合，删除不满足比较条件的元素。

compare

使用这些函数比较两个或多个值。

compare.Conditional (cond): 根据控制参数的值返回两个参数之一。
compare.Default (default): 如果设置了第二个参数，则返回第二个参数，否则返回第一个参数。
compare.Eq (eq): 返回 arg1 == arg2 || arg1 == arg3 的布尔真值。
compare.Ge (ge): 返回 arg1 >= arg2 且 arg1 >= arg3 的布尔真值。
compare.Gt (gt): 返回 arg1 > arg2 且 arg1 > arg3 的布尔真值。
compare.Le (le): 返回 arg1 <= arg2 且 arg1 <= arg3 的布尔真值。
compare.Lt (lt): 返回 arg1 < arg2 且 arg1 < arg3 的布尔真值。
compare.Ne (ne): 返回 arg1 != arg2 且 arg1 != arg3 的布尔真值。

crypto

使用这些函数创建加密哈希。

crypto.FNV32a: 返回给定字符串的 32 位 FNV (Fowler–Noll–Vo) 非加密哈希值。
crypto.HMAC (hmac): 返回使用密钥对消息进行签名的加密哈希值。
crypto.MD5 (md5): 对给定输入进行哈希处理，并返回其编码为十六进制字符串的 MD5 校验和。
crypto.SHA1 (sha1): 对给定输入进行哈希处理，并返回其编码为十六进制字符串的 SHA1 校验和。
crypto.SHA256 (sha256): 对给定输入进行哈希处理，并返回其编码为十六进制字符串的 SHA256 校验和。

css

使用这些函数来处理 CSS 和 Sass 文件。

css.PostCSS (postCSS): 使用任何 PostCSS 插件处理给定的资源。
css.Sass (toCSS): 将 Sass 转译为 CSS。
css.TailwindCSS: 使用 Tailwind CSS CLI 处理给定的资源。

data

使用这些函数读取本地或远程数据文件。

data.GetCSV (getCSV): 从本地或远程 CSV 文件返回一个数组的数组，如果文件不存在则返回错误。
data.GetJSON (getJSON): 从本地或远程 JSON 文件返回一个 JSON 对象，如果文件不存在则返回错误。

debug

使用这些函数调试您的模板。

debug.Dump: 将对象转储为字符串返回。
debug.Timer: 创建一个命名的计时器，将经过的时间报告到控制台。

diagrams

使用这些函数渲染图表。

diagrams.Goat: 将 ASCII 艺术转换为 SVG 图表，返回一个 GoAT 图表对象。

encoding

使用这些函数来编码和解码数据。

encoding.Base64Decode (base64Decode): 返回给定内容的 base64 解码。
encoding.Base64Encode (base64Encode): 返回给定内容的 base64 解码。
encoding.Jsonify (jsonify): 将给定对象编码为 JSON。

fmt

使用这些函数在模板中打印字符串或向终端打印消息。

fmt.Errorf (errorf): 从模板记录一个错误。
fmt.Erroridf (erroridf): 从模板记录一个可抑制的错误。
fmt.Print (print): 使用标准的 fmt.Print 函数打印给定参数的默认表示形式。
fmt.Printf (printf): 使用标准的 fmt.Sprintf 函数格式化字符串。
fmt.Println (println): 使用标准的 fmt.Print 函数打印给定参数的默认表示形式，并强制换行。
fmt.Warnf (warnf): 从模板记录一个警告。
fmt.Warnidf (warnidf): 从模板记录一个可抑制的警告。

global

使用这些全局函数访问页面和站点数据。

page: 提供对 Page 对象的全局访问。
site: 提供对当前 Site 对象的全局访问。

go template

这些是 Go 的 text/template 包提供的函数、运算符和语句。

and: 返回第一个为假的参数。如果所有参数都为真，则返回最后一个参数。
block: 定义一个模板并在原地执行它。
break: 与 range 语句一起使用，停止最内层的迭代并跳过所有剩余的迭代。
continue: 与 range 语句一起使用，停止最内层的迭代并继续下一次迭代。
define: 定义一个模板。
else: 为 if、with 和 range 语句开始一个备用块。
end: 终止 if、with、range、block 和 define 语句。
if: 如果表达式为真，则执行该块。
len: 返回字符串、切片、映射或集合的长度。
not: 返回其单个参数的布尔否定。
or: 返回第一个为真的参数。如果所有参数都为假，则返回最后一个参数。
range: 迭代一个非空集合，将上下文（点）绑定到连续的元素，并执行该块。
return: 在部分模板中使用，终止模板执行并返回给定值（如果有）。
template: 执行给定的模板，可以选择传递上下文。
try: 在评估给定表达式后返回一个 TryValue 对象。
urlquery: 返回其参数的文本表示形式的转义值，该值适合嵌入到 URL 查询中。
with: 将上下文（点）绑定到表达式，如果表达式为真，则执行该块。

hash

使用这些函数创建非加密哈希。

hash.FNV32a: 返回给定字符串的 32 位 FNV (Fowler–Noll–Vo) 非加密哈希值。
hash.XxHash (xxhash): 返回给定字符串的 64 位 xxHash 非加密哈希值。

hugo

使用这些函数访问有关 Hugo 应用程序和当前环境的信息。

hugo.BuildDate: 返回 Hugo 二进制文件的编译日期。
hugo.CommitHash: 返回 Hugo 二进制文件的 Git 提交哈希值。
hugo.Deps: 返回项目依赖项的切片，可以是 Hugo 模块或本地主题组件。
hugo.Environment: 返回当前运行环境。
hugo.Generator: 呈现一个 HTML meta 元素，用于标识生成该站点的软件。
hugo.GoVersion: 返回用于编译 Hugo 二进制文件的 Go 版本。
hugo.IsDevelopment: 报告当前运行环境是否为“development”。
hugo.IsExtended: 报告 Hugo 二进制文件是否为扩展版本。
hugo.IsMultihost: 报告每个配置的语言是否具有唯一的基 URL。
hugo.IsMultilingual: 报告是否有两个或多个配置的语言。
hugo.IsProduction: 报告当前运行环境是否为“production”。
hugo.IsServer: 报告内置开发服务器是否正在运行。
hugo.Store: 返回一个全局的、持久的“暂存板”，用于存储和操作数据。
hugo.Version: 返回 Hugo 二进制文件的当前版本。
hugo.WorkingDir: 返回项目工作目录。

images

使用这些函数创建图像滤镜、将图像滤镜应用于图像以及检索图像信息。

images.AutoOrient: 返回一个图像滤镜，该滤镜会根据图像的 EXIF 方向标签按需旋转和翻转图像。
images.Brightness: 返回一个图像滤镜，用于更改图像的亮度。
images.ColorBalance: 返回一个图像滤镜，用于更改图像的色彩平衡。
images.Colorize: 返回一个图像滤镜，用于生成图像的着色版本。
images.Config: 从指定路径（相对于工作目录）的图像返回一个 image.Config 结构。
images.Contrast: 返回一个图像滤镜，用于更改图像的对比度。
images.Dither: 返回一个图像滤镜，用于对图像进行抖动处理。
images.Filter: 将一个或多个图像滤镜应用于给定的图像资源。
images.Gamma: 返回一个图像滤镜，用于对图像执行伽玛校正。
images.GaussianBlur: 返回一个图像滤镜，用于将高斯模糊应用于图像。
images.Grayscale: 返回一个图像滤镜，用于生成图像的灰度版本。
images.Hue: 返回一个图像滤镜，用于旋转图像的色调。
images.Invert: 返回一个图像滤镜，用于反转图像的颜色。
images.Mask: 返回一个图像滤镜，用于将蒙版应用于源图像。
images.Opacity: 返回一个图像滤镜，用于更改图像的不透明度。
images.Overlay: 返回一个图像滤镜，用于将源图像叠加到给定坐标处（相对于左上角）。
images.Padding: 返回一个图像滤镜，用于调整图像画布的大小，而不调整图像本身的大小。
images.Pixelate: 返回一个图像滤镜，用于对图像应用像素化效果。
images.Process: 返回一个图像滤镜，用于使用给定的规范处理给定的图像。
images.QR: 使用指定的选项将给定的文本编码为二维码，并返回图像资源。
images.Saturation: 返回一个图像滤镜，用于更改图像的饱和度。
images.Sepia: 返回一个图像滤镜，用于生成图像的棕褐色调版本。
images.Sigmoid: 返回一个图像滤镜，用于使用 S 型函数更改图像的对比度。
images.Text: 返回一个图像滤镜，用于向图像添加文本。
images.UnsharpMask: 返回一个图像滤镜，用于锐化图像。

inflect

这些函数提供英语名词的单数化和复数化等词形变化功能。

inflect.Humanize (humanize): 返回输入的人性化版本，首字母大写。
inflect.Pluralize (pluralize): 根据一组常见的英语复数规则，将给定的单词复数化。
inflect.Singularize (singularize): 根据一组常见的英语单数化规则，将给定的单词单数化。

js

使用这些函数来处理 JavaScript 和 TypeScript 文件。

js.Build: 捆绑、转译、树摇和缩小 JavaScript 资源。
js.Batch: 使用全局代码拆分和灵活的钩子/运行器设置构建 JavaScript 包组。
js.Babel (babel 或 /hugo-pipes/babel/): 使用 Babel 编译给定的 JavaScript 资源。

lang

使用这些函数来调整您的站点以满足语言和区域要求。

lang.FormatAccounting: 以会计记账法返回给定货币和精度的数字的货币表示形式，针对当前语言和区域。
lang.FormatCurrency: 返回给定货币和精度的数字的货币表示形式，针对当前语言和区域。
lang.FormatNumber: 返回具有给定精度的数字的数字表示形式，针对当前语言和区域。
lang.FormatNumberCustom: 使用负数、小数和分组选项返回具有给定精度的数字的数字表示形式。
lang.FormatPercent: 返回具有给定精度的数字的百分比表示形式，针对当前语言和区域。
lang.Merge: 合并其他语言中缺少的翻译。
lang.Translate (T 或 i18n): 使用 i18n 目录中的翻译表翻译字符串。

math

使用这些函数来执行数学运算。

math.Abs: 返回给定数字的绝对值。
math.Acos: 返回给定数字的反余弦值（以弧度为单位）。
math.Add (add): 将两个或多个数字相加。
math.Asin: 返回给定数字的反正弦值（以弧度为单位）。
math.Atan: 返回给定数字的反正切值（以弧度为单位）。
math.Atan2: 返回给定数字对的反正切值（以弧度为单位），并根据它们的符号确定正确的象限。
math.Ceil: 返回大于或等于给定数字的最小整数值。
math.Cos: 返回给定弧度数的余弦值。
math.Counter: 递增并返回全局计数器。
math.Div (div): 将第一个数字除以一个或多个数字。
math.Floor: 返回小于或等于给定数字的最大整数值。
math.Log: 返回给定数字的自然对数。
math.Max: 返回所有数字中较大的一个。接受标量、切片或两者。
math.Min: 返回所有数字中较小的一个。接受标量、切片或两者。
math.Mod (mod): 返回两个整数的模数。
math.ModBool (modBool): 报告两个整数的模数是否等于 0。
math.Mul (mul): 将两个或多个数字相乘。
math.Pi: 返回数学常数 pi。
math.Pow (pow): 返回第一个数字的第二个数字次方。
math.Product: 返回所有数字的乘积。接受标量、切片或两者。
math.Rand: 返回半开区间 [0.0, 1.0) 中的伪随机数。
math.Round: 返回最接近的整数，四舍五入远离零。
math.Sin: 返回给定弧度数的正弦值。
math.Sqrt: 返回给定数字的平方根。
math.Sub (sub): 从第一个数字中减去一个或多个数字。
math.Sum: 返回所有数字的总和。接受标量、切片或两者。
math.Tan: 返回给定弧度数的正切值。
math.ToDegrees: ToDegrees 将弧度转换为度。
math.ToRadians: ToRadians 将度转换为弧度。

openapi3

使用这些函数来处理 OpenAPI 3 定义。

openapi3.Unmarshal: 将给定的资源反序列化为 OpenAPI 3 文档。

os

使用这些函数与操作系统交互。

os.FileExists (fileExists): 报告文件或目录是否存在。
os.Getenv (getenv): 返回环境变量的值，如果未设置环境变量，则返回空字符串。
os.ReadDir (readDir): 返回按文件名排序的 FileInfo 结构数组，每个目录条目对应一个元素。
os.ReadFile (readFile): 返回文件的内容。
os.Stat: 返回描述文件或目录的 FileInfo 结构。

partials

使用这些函数来调用局部模板。

partials.Include (partial): 执行给定的局部模板，可以选择传递上下文。如果局部模板包含 return 语句，则返回给定值，否则返回渲染的输出。
partials.IncludeCached (partialCached): 执行给定的模板并缓存结果，可以选择传递上下文。如果局部模板包含 return 语句，则返回给定的值，否则返回渲染后的输出。

path

使用这些函数来处理文件路径。

path.Base: 将路径分隔符替换为斜杠 (/)，并返回给定路径的最后一个元素。
path.BaseName: 将路径分隔符替换为斜杠 (/)，并返回给定路径的最后一个元素，如果存在则删除扩展名。
path.Clean: 将路径分隔符替换为斜杠 (/)，并返回与给定路径等效的最短路径名。
path.Dir: 将路径分隔符替换为斜杠 (/)，并返回给定路径的所有元素，除了最后一个。
path.Ext: 将路径分隔符替换为斜杠 (/)，并返回给定路径的文件名扩展名。
path.Join: 将路径分隔符替换为斜杠 (/)，将给定的路径元素连接成一个路径，并返回与结果等效的最短路径名。
path.Split: 将路径分隔符替换为斜杠 (/)，并在最后一个斜杠之后立即拆分结果路径，将其分为目录和文件名组件。

reflect

使用这些函数来确定值的数据类型。

reflect.IsMap: 报告给定值是否为 map。
reflect.IsSlice: 报告给定值是否为 slice。

resources

使用这些函数来处理资源。

resources.Babel: 使用 Babel 编译给定的 JavaScript 资源。
resources.ByType: 返回给定媒体类型的全局资源集合，如果没有找到则返回 nil。
resources.Concat: 返回连接的资源切片。
resources.Copy: 将给定资源复制到目标路径。
resources.ExecuteAsTemplate: 返回从 Go 模板创建的资源，该模板已解析并使用给定的上下文执行。
resources.Fingerprint (指纹): 以加密方式哈希给定资源的内容。
resources.FromString: 返回从字符串创建的资源。
resources.Get: 从给定路径返回全局资源，如果没有找到则返回 nil。
resources.GetMatch: 从与给定 glob 模式匹配的路径返回第一个全局资源，如果没有找到则返回 nil。
resources.GetRemote: 从给定 URL 返回远程资源，如果没有找到则返回 nil。
resources.Match: 从与给定 glob 模式匹配的路径返回全局资源集合，如果没有找到则返回 nil。
resources.Minify (minify): 缩小给定的资源。
resources.PostCSS: 使用任何 PostCSS 插件处理给定的资源。
resources.PostProcess: 在构建之后处理给定资源。
resources.ToCSS: 将 Sass 转译为 CSS。

safe

使用这些函数在 Go 的 html/template 包的上下文中将值声明为安全。

safe.CSS (safeCSS): 将给定字符串声明为安全的 CSS 字符串。
safe.HTML (safeHTML): 将给定字符串声明为安全的 HTML 字符串。
safe.HTMLAttr (safeHTMLAttr): 将给定的键值对声明为安全的 HTML 属性。
safe.JS (safeJS): 将给定字符串声明为安全的 JavaScript 表达式。
safe.JSStr (safeJSStr): 将给定字符串声明为安全的 JavaScript 字符串。
safe.URL (safeURL): 将给定字符串声明为安全的 URL 或 URL 子字符串。

strings

使用这些函数来处理字符串。

strings.Chomp (chomp): 返回给定字符串，删除所有尾随换行符和回车符。
strings.Contains: 报告给定字符串是否包含给定的子字符串。
strings.ContainsAny: 报告给定字符串是否包含给定集合中的任何字符。
strings.ContainsNonSpace: 报告给定字符串是否包含 Unicode 定义的任何非空格字符。
strings.Count: 返回给定字符串中给定子字符串的不重叠实例数。
strings.CountRunes (countrunes): 返回给定字符串中不包括空格的 rune 数。
strings.CountWords (countwords): 返回给定字符串中的单词数。
strings.Diff: 以统一的 diff 格式返回两个文本 OLD 和 NEW 的锚定差异。如果 OLD 和 NEW 相同，则返回一个空字符串。
strings.FindRE (findRE): 返回与正则表达式匹配的字符串切片。
strings.FindRESubmatch (findRESubmatch): 返回正则表达式的所有连续匹配项的切片。每个元素都是一个字符串切片，其中包含正则表达式最左侧匹配的文本以及其子表达式（如果有）的匹配项。
strings.FirstUpper: 返回给定字符串，并将第一个字符大写。
strings.HasPrefix (hasPrefix): 报告给定字符串是否以给定的前缀开头。
strings.HasSuffix (hasSuffix): 报告给定字符串是否以给定的后缀结尾。
strings.Repeat: 返回一个由另一个字符串的零个或多个副本组成的新字符串。
strings.Replace (replace): 返回 INPUT 的副本，将所有出现的 OLD 替换为 NEW。
strings.ReplaceRE (replaceRE): 返回 INPUT 的副本，将所有出现的正则表达式替换为替换模式。
strings.RuneCount: 返回给定字符串中的 rune 数。
strings.SliceString (slicestr): 返回给定字符串的子字符串，从起始位置开始，并在结束位置之前结束。
strings.Split (split): 返回一个字符串切片，通过分隔符拆分给定字符串。
strings.Substr (substr): 返回给定字符串的子字符串，从起始位置开始，并在给定的长度后结束。
strings.Title (title): 返回给定字符串，将其转换为首字母大写形式。
strings.ToLower (lower): 返回给定字符串，将所有字符转换为小写。
strings.ToUpper (upper): 返回给定字符串，将所有字符转换为大写。
strings.Trim (trim): 返回给定字符串，删除 cutset 中指定的前导和尾随字符。
strings.TrimLeft: 返回给定字符串，删除 cutset 中指定的前导字符。
strings.TrimPrefix: 返回给定字符串，从字符串的开头删除前缀。
strings.TrimRight: 返回给定字符串，删除 cutset 中指定的尾随字符。
strings.TrimSpace: 返回给定字符串，删除 Unicode 定义的前导和尾随空格。
strings.TrimSuffix: 返回给定字符串，从字符串的末尾删除后缀。
strings.Truncate (truncate): 返回给定字符串，将其截断为最大长度，而不切断单词或留下未关闭的 HTML 标记。

templates

使用这些函数来查询模板系统。

templates.Defer: 延迟模板的执行，直到所有站点和输出格式都已呈现之后。
templates.Exists: 报告在相对于布局目录的给定路径下是否存在模板文件。

time

使用这些函数来处理时间值。

time.AsTime (time): 以 time.Time 值返回日期/时间值的给定字符串表示形式。
time.Duration (duration): 使用给定的时间单位和数字返回 time.Duration 值。
time.Format (dateFormat): 以格式化和本地化的字符串形式返回给定的日期/时间。
time.Now (now): 返回当前本地时间。
time.ParseDuration: 通过解析给定的持续时间字符串返回 time.Duration 值。

转换

使用这些函数将值从一种格式转换为另一种格式。

transform.CanHighlight: 报告 Chroma 语法高亮器是否支持给定的代码语言。
transform.Emojify (emojify): 通过 Emoji 表情处理器处理字符串。
transform.Highlight (highlight): 使用语法高亮器渲染代码。
transform.HighlightCodeBlock: 高亮显示代码块渲染钩子中接收到的上下文中的代码。
transform.HTMLEscape (htmlEscape): 返回给定的字符串，通过将特殊字符替换为 HTML 实体进行转义。
transform.HTMLUnescape (htmlUnescape): 返回给定的字符串，将每个 HTML 实体替换为其对应的字符。
transform.Markdownify (markdownify): 将 Markdown 渲染为 HTML。
transform.Plainify (plainify): 返回一个删除所有 HTML 标签的字符串。
transform.Remarshal: 将序列化数据字符串或映射，转换为指定格式的序列化数据字符串。
transform.ToMath: 使用 KaTeX 渲染数学表达式。
transform.Unmarshal (unmarshal): 解析序列化数据并返回映射或数组。支持 CSV、JSON、TOML、YAML 和 XML。
transform.XMLEscape: 返回给定的字符串，删除不允许的字符，然后将结果转义为 XML 等效项。

URLs

使用这些函数来处理 URL。

urls.AbsLangURL (absLangURL): 返回带有语言前缀的绝对 URL（如果有）。
urls.AbsURL (absURL): 返回一个绝对 URL。
urls.Anchorize (anchorize): 返回给定的字符串，为在 HTML id 属性中使用进行清理。
urls.JoinPath: 将提供的元素连接成一个 URL 字符串，并清理结果中的任何 ./ 或 ../ 元素。如果参数列表为空，则 JoinPath 返回一个空字符串。
urls.Parse: 将 URL 解析为 URL 结构。
urls.Ref (ref): 返回给定路径页面的绝对永久链接。
urls.RelLangURL (relLangURL): 返回带有语言前缀的相对 URL（如果有）。
urls.RelRef (relref): 返回给定路径页面的相对永久链接。
urls.RelURL (relURL): 返回一个相对 URL。
urls.URLize (urlize): 返回给定的字符串，为在 URL 中使用进行清理。

函数