hugo/docs/content/en/functions/transform/Highlight.md

title	description	categories	keywords	params	aliases
transform.Highlight	Renders code with a syntax highlighter.		highlight	functions_and_methods aliases returnType signatures highlight template.HTML transform.Highlight CODE LANG [OPTIONS]	/functions/highlight

The highlight function uses the Chroma syntax highlighter, supporting over 200 languages with more than 40 highlighting styles.

Arguments

The transform.Highlight shortcode takes three arguments.

CODE

(string) The code to highlight.

LANG

(string) The language of the code to highlight. Choose from one of the supported languages. This value is case-insensitive.

OPTIONS

(map or string) A map or comma-separated key-value pairs wrapped in quotation marks. Set default values for each option in your site configuration. The key names are case-insensitive.

Examples

{{ $input := `fmt.Println("Hello World!")` }}
{{ transform.Highlight $input "go" }}

{{ $input := `console.log('Hello World!');` }}
{{ $lang := "js" }}
{{ transform.Highlight $input $lang "lineNos=table, style=api" }}

{{ $input := `echo "Hello World!"` }}
{{ $lang := "bash" }}
{{ $opts := dict "lineNos" "table" "style" "dracula" }}
{{ transform.Highlight $input $lang $opts }}

Options

{{% include "_common/syntax-highlighting-options.md" %}}