zola/docs/content/documentation/templates/pagination.md
2018-09-30 23:49:32 +02:00

1.1 KiB

+++ title = "Pagination" weight = 30 +++

Two things can get paginated: a section or a taxonomy term.

A paginated section gets the same section variable as a normal section page minus its pages while a paginated taxonomy gets the a taxonomy variable of type TaxonomyConfig, equivalent to the taxonomy definition in the config.toml.

In addition, a paginated page gets a paginator variable of the Pager type:

// How many items per page
paginate_by: Number;
// The base URL for the pagination: section permalink + pagination path
// You can concatenate an integer with that to get a link to a given pagination page.
base_url: String;
// How many pagers in this paginator
number_pagers: Number;
// Permalink to the first page
first: String;
// Permalink to the last page
last: String;
// Permalink to the previous page, if there is one
previous: String?;
// Permalink to the next page, if there is one
next: String?;
// All pages for the current page
pages: Array<Page>;
// Which page are we on
current_index: Number;