With many websites — especially blogs — it’s very common to break the main listing of posts up into smaller lists and display them over multiple pages. Jekyll offers a pagination plugin, so you can automatically generate the appropriate files and folders you need for paginated listings.
For Jekyll 3, include the
jekyll-paginate plugin in your Gemfile and in
gems. For Jekyll 2, this is standard.
Pagination only works within HTML files
Pagination does not work from within Markdown or Textile files from
your Jekyll site. Pagination works when called from within the HTML
index.html, which optionally may reside in and
produce pagination from within a subdirectory, via the
paginate_path configuration value.
To enable pagination for your blog, add a line to the
_config.yml file that
specifies how many items should be displayed per page:
The number should be the maximum number of Posts you’d like to be displayed per-page in the generated site.
You may also specify the destination of the pagination pages:
This will read in
blog/index.html, send it each pagination page in Liquid as
paginator and write the output to
:num is the
pagination page number, starting with
2. If a site has 12 posts and specifies
paginate: 5, Jekyll will write
blog/index.html with the first 5 posts,
blog/page2/index.html with the next 5 posts
blog/page3/index.html with the last 2 posts into the destination
Don't set a permalink
Setting a permalink in the front matter of your blog page will cause pagination to break. Just omit the permalink.
Liquid Attributes Available
The pagination plugin exposes the
paginator liquid object with the following
current page number
number of posts per page
a list of posts for the current page
total number of posts in the site
number of pagination pages
page number of the previous pagination page,
path of previous pagination page,
page number of the next pagination page,
path of next pagination page,
Pagination does not support tags or categories
Pagination pages through every post in the
variable regardless of variables defined in the YAML Front Matter of
each. It does not currently allow paging over groups of posts linked
by a common tag or category. It cannot include any collection of
documents because it is restricted to posts.
Render the paginated Posts
The next thing you need to do is to actually display your posts in a list using
paginator variable that will now be available to you. You’ll probably
want to do this in one of the main pages of your site. Here’s one example of a
simple way of rendering paginated Posts in a HTML file:
Beware the page one edge-case
Jekyll does not generate a ‘page1’ folder, so the above code will not work
/page1 link is produced. See below for a way to handle
this if it’s a problem for you.
The following HTML snippet should handle page one, and render a list of each page with links to all but the current page.