HUGO
News Docs Themes Community GitHub

collections.First

Returns the given collection, limited to the first N elements.

Syntax

collections.First N COLLECTION

Returns

any

Alias

first
{{ slice "a" "b" "c" | first 1 }} → [a]
{{ slice "a" "b" "c" | first 2 }} → [a b]

Given that a string is in effect a read-only slice of bytes, this function can be used to return the specified number of bytes from the beginning of the string:

{{ "abc" | first 1 }} → a
{{ "abc" | first 2 }} → ab

Note that a character may consist of multiple bytes:

{{ "Schön" | first 3 }} → Sch
{{ "Schön" | first 4 }} → Sch\xc3
{{ "Schön" | first 5 }} → Schö

To use the collections.First function with a page collection:

{{ range first 5 .Pages }}
  {{ .Render "summary" }}
{{ end }}

Set N to zero to return an empty collection:

{{ $emptyPageCollection := first 0 .Pages }}

Use first and where together:

{{ range where .Pages "Section" "articles" | first 5 }}
  {{ .Render "summary" }}
{{ end }}