transform.HighlightCodeBlock

Syntax

transform.HighlightCodeBlock CONTEXT [OPTIONS]

Returns

highlight.HighlightResult

这个函数只在代码块渲染挂钩中有用。

给定传入代码块渲染挂钩的上下文，transform.HighlightCodeBlock 返回一个带有两个方法的 HighlightResult 对象。

.Wrapped: (template.HTML) 返回用 <div>, <pre>, 和 <code> 元素包装的突出显示的代码。这与 transform.Highlight 函数返回的值相同。
.Inner: (template.HTML) 返回不带任何包装元素的突出显示的代码，允许您创建自己的包装器。

{{ $result := transform.HighlightCodeBlock . }}
{{ $result.Wrapped }}

要覆盖默认的突出显示选项：

{{ $opts := merge .Options (dict "linenos" true) }}
{{ $result := transform.HighlightCodeBlock . $opts }}
{{ $result.Wrapped }}

See also