This class reference is valid for all Hugo and Go grammars. Exceptions are mentioned in the respective sections.

Core modes used

• hljs.NUMBER_MODE
• hljs.QUOTE_STRING_MODE
• hljs.APOS_STRING_MODE (as base for string.rune)
• hljs.COMMENT

Standard scopes (classes)

The following standard scopes are used to style the output. Make sure your style has a definition for them.

• comment

  Used for opening and closing comment tags and inner text {{/*, {{- /*, */ -}}, */}}

• number

  all kind of numbers

• operator

  Used for the following items : |, ,, =, :=

• property

  Used for dot chained words except if the chain starts with a built_in. In that case the beginning of the chain gets built_in (one or two words). see also property.method below.

  With Go grammars there’s nothing like that, a.b is a property just a is not.

• punctuation

  Used for opening and closing parenthesis of sub expressions: (, )

• string

  Strings (single and double quoted).

• template-tag

  Used for opening and closing template tags. {{, {{-, -}}, }}

• template-variable

  Used for template variables starting with a $ (example $myVar)

New scopes (classes)

Themes out in the wild won’t have styles for these. If you do not define any for these special subclasses, Highlight.js will fallback to the parent style.

• property.method (valid for Hugo only)

  A context, variable or built_in followed by a dot should be a method call. Target this with the .hljs-property.method_ selector.

• template-variable.context

  The Context – a leading . or $. – is a special thing in Go/Hugo templating. Target this with the .hljs-template-variable.context_ selector.

• string.raw

  A raw string in Go/Hugo templates is a sequence of characters enclosed in backticks. Target this with the .hljs-string.raw_ selector.

• string.rune

  A rune literal in Go/Hugo templates is a sequence of characters enclosed in single quotes. Target this with the .hljs-string.rune_ selector.

Keywords

We divide Go/Hugo keywords into the following standard scopes.

• literal

  not many with Hugo, just: false, nil, true

• keyword

  For Hugo as documented in Hugo - go template functions

  For Go as documented in Go template actions and define¹

  For both urlquery is moved to built_ins. ²

• built_in

  For Hugo as documented in Hugo - Functions excluding the keywords from above. Both – the real namespaced function name and it’s aliases are available.

  For Go as documented in Go Template-Text Predefined template functions

HINT: Keywords for Hugo are generated at build time from a recent version of the docs. For older template code bases this may result in missing highlighting ancient keywords/built_ins. The Go template keywords are manually picked from the docs.

Sub modes

The HTML grammars use XML as subLanguage. Check the official documentation for scopes used there.