Highlight shortcode

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

Arguments

The highlight shortcode takes three arguments.

{{< highlight LANG OPTIONS >}}
CODE
{{< /highlight >}}

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

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

Example

{{< highlight go "linenos=inline, hl_lines=3 6-8, style=emacs" >}}
package main

import "fmt"

func main() {
    for i := 0; i < 3; i++ {
        fmt.Println("Value of i:", i)
    }
}
{{< /highlight >}}

Hugo renders this to:

1package main
2
3import "fmt"
4
5func main() {
6    for i := 0; i < 3; i++ {
7            fmt.Println("Value of i:", i)
8    }
9}

You can also use the highlight shortcode for inline code snippets:

This is some {{< highlight go "hl_inline=true" >}}fmt.Println("inline"){{< /highlight >}} code.

Hugo renders this to:

This is some fmt.Println("inline") code.

Given the verbosity of the example above, if you need to frequently highlight inline code snippets, create your own shortcode using a shorter name with preset options.

{{ $code := .Inner | strings.TrimSpace }}
{{ $lang := or (.Get 0) "go" }}
{{ $opts := dict "hl_inline" true "noClasses" true }}
{{ transform.Highlight $code $lang $opts }}

This is some {{< hl >}}fmt.Println("inline"){{< /hl >}} code.

Hugo renders this to:

This is some fmt.Println("inline") code.

Options

Pass the options when calling the shortcode. You can set their default values in your site configuration.

anchorLineNos

(bool) Whether to render each line number as an HTML anchor element, setting the id attribute of the surrounding span element to the line number. Irrelevant if lineNos is false. Default is false.

codeFences

(bool) Whether to highlight fenced code blocks. Default is true.

guessSyntax

(bool) Whether to automatically detect the language if the LANG argument is blank or set to a language for which there is no corresponding lexer. Falls back to a plain text lexer if unable to automatically detect the language. Default is false.

The Chroma syntax highlighter includes lexers for approximately 250 languages, but only 5 of these have implemented automatic language detection.

hl_Lines

(string) A space-delimited list of lines to emphasize within the highlighted code. To emphasize lines 2, 3, 4, and 7, set this value to 2-4 7. This option is independent of the lineNoStart option.

hl_inline

(bool) Whether to render the highlighted code without a wrapping container. Default is false.

lineAnchors

(string) When rendering a line number as an HTML anchor element, prepend this value to the id attribute of the surrounding span element. This provides unique id attributes when a page contains two or more code blocks. Irrelevant if lineNos or anchorLineNos is false.

lineNoStart

(int) The number to display at the beginning of the first line. Irrelevant if lineNos is false. Default is 1.

lineNos

(any) Controls line number display. Default is false.

• true: Enable line numbers, controlled by lineNumbersInTable.
• false: Disable line numbers.
• inline: Enable inline line numbers (sets lineNumbersInTable to false).
• table: Enable table-based line numbers (sets lineNumbersInTable to true).

lineNumbersInTable

(bool) Whether to render the highlighted code in an HTML table with two cells. The left table cell contains the line numbers, while the right table cell contains the code. Irrelevant if lineNos is false. Default is true.

noClasses

(bool) Whether to use inline CSS styles instead of an external CSS file. Default is true. To use an external CSS file, set this value to false and generate the CSS file from the command line:

hugo gen chromastyles --style=monokai > syntax.css

style

(string) The CSS styles to apply to the highlighted code. Case-sensitive. Default is monokai. See syntax highlighting styles.

tabWidth

(int) Substitute this number of spaces for each tab character in your highlighted code. Irrelevant if noClasses is false. Default is 4.

wrapperClass

New in v0.140.2

(string) The class or classes to use for the outermost element of the highlighted code. Default is highlight.