hugo/docs/content/en/methods/page/Paginate.md

title	description	categories	keywords	action
Paginate	Paginates a collection of pages.			related returnType signatures methods/page/Paginator page.Pager PAGE.Paginate COLLECTION [N]

Pagination is the process of splitting a list page into two or more pagers, where each pager contains a subset of the page collection and navigation links to other pagers.

By default, the number of elements on each pager is determined by the value of the paginate setting in your site configuration. The default value is 10. Override the value in your site configuration by providing a second argument, an integer, when calling the Paginate method.

{{% note %}} There is also a Paginator method on Page objects, but it can neither filter nor sort the page collection.

The Paginate method is more flexible. {{% /note %}}

You can invoke pagination on the home page template, section templates, taxonomy templates, and term templates.

{{< code file=layouts/_default/list.html >}} {{ $pages := where .Site.RegularPages "Section" "articles" }} {{ $pages = $pages.ByTitle }} {{ range (.Paginate $pages 7).Pages }}

{{ .Title }}

{{ end }} {{ template "_internal/pagination.html" . }} {{< /code >}}

In the example above, we:

1. Build a page collection
2. Sort the collection by title
3. Paginate the collection, with 7 elements per pager
4. Range over the paginated page collection, rendering a link to each page
5. Call the internal "pagination" template to create the navigation links between pagers.

{{% note %}} Please note that the results of pagination are cached. Once you have invoked either the Paginator or Paginate method, the paginated collection is immutable. Additional invocations of these methods will have no effect. {{% /note %}}