sort

Syntax

sort COLLECTION [KEY] [ORDER]

The KEY is optional when sorting slices in ascending order, otherwise it is required. When sorting slices, use the literal value in place of the KEY. See examples below.

The ORDER may be either asc (ascending) or desc (descending). The default sort order is ascending.

Sort a slice

The examples below assume this site configuration:

params:
  grades:
  - b
  - a
  - c

[params]
  grades = ['b', 'a', 'c']

{
   "params": {
      "grades": [
         "b",
         "a",
         "c"
      ]
   }
}

Ascending order

Sort slice elements in ascending order using either of these constructs:

{{ sort site.Params.grades }} → [a b c]
{{ sort site.Params.grades "value" "asc" }} → [a b c]

In the examples above, value is the KEY representing the value of the slice element.

Descending order

Sort slice elements in descending order:

{{ sort site.Params.grades "value" "desc" }} → [c b a]

In the example above, value is the KEY representing the value of the slice element.

Sort a map

The examples below assume this site configuration:

params:
  authors:
    a:
      firstName: Marius
      lastName: Pontmercy
    b:
      firstName: Victor
      lastName: Hugo
    c:
      firstName: Jean
      lastName: Valjean

[params]
  [params.authors]
    [params.authors.a]
      firstName = 'Marius'
      lastName = 'Pontmercy'
    [params.authors.b]
      firstName = 'Victor'
      lastName = 'Hugo'
    [params.authors.c]
      firstName = 'Jean'
      lastName = 'Valjean'

{
   "params": {
      "authors": {
         "a": {
            "firstName": "Marius",
            "lastName": "Pontmercy"
         },
         "b": {
            "firstName": "Victor",
            "lastName": "Hugo"
         },
         "c": {
            "firstName": "Jean",
            "lastName": "Valjean"
         }
      }
   }
}

Ascending order

Sort map objects in ascending order using either of these constructs:

{{ range sort site.Params.authors "firstname" }}
  {{ .firstName }}
{{ end }}

{{ range sort site.Params.authors "firstname" "asc" }}
  {{ .firstName }}
{{ end }}

These produce:

Jean Marius Victor

Descending order

Sort map objects in descending order:

{{ range sort site.Params.authors "firstname" "desc" }}
  {{ .firstName }}
{{ end }}

This produces:

Victor Marius Jean

Sort a page collection

Although you can use the sort function to sort a page collection, Hugo provides built-in methods for sorting page collections by:

• weight
• linktitle
• title
• front matter parameter
• date
• expiration date
• last modified date
• publish date
• length

In this contrived example, sort the site’s regular pages by .Type in descending order:

{{ range sort site.RegularPages "Type" "desc" }}
  <h2><a href="{{ .RelPermalink }}">{{ .Title }}</a></h2>
{{ end }}