docs/_docs/pagination.md
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 or higher, include the jekyll-paginate plugin in your
Gemfile and in your _config.yml under plugins. For Jekyll 2, this is
standard.
To enable pagination for posts on your blog, add a line to the _config.yml file that
specifies how many items should be displayed per page:
paginate: 5
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:
paginate_path: "/blog/page:num/"
This will read in blog/index.html, send it each pagination page in Liquid as
paginator and write the output to blog/page:num/, where :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 and
blog/page3/index.html with the last 2 posts into the destination directory.
The pagination plugin exposes the paginator liquid object with the following
attributes:
{% include docs_variables_table.html scope=site.data.jekyll_variables.paginator %}
<div class="note info"> <h5>Pagination does not support tags or categories</h5> <p>Pagination pages through every post in the <code>posts</code> variable unless a post has <code>hidden: true</code> in its front matter. 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.</p> </div>The next thing you need to do is to actually display your posts in a list using
the 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:
{% raw %}
---
layout: default
title: My Blog
---
<!-- This loops through the paginated posts -->
{% for post in paginator.posts %}
<h1><a href="{{ post.url }}">{{ post.title }}</a></h1>
<p class="author">
<span class="date">{{ post.date }}</span>
</p>
<div class="content">
{{ post.content }}
</div>
{% endfor %}
<!-- Pagination links -->
<div class="pagination">
{% if paginator.previous_page %}
<a href="{{ paginator.previous_page_path }}" class="previous">
Previous
</a>
{% else %}
<span class="previous">Previous</span>
{% endif %}
<span class="page_number ">
Page: {{ paginator.page }} of {{ paginator.total_pages }}
</span>
{% if paginator.next_page %}
<a href="{{ paginator.next_page_path }}" class="next">Next</a>
{% else %}
<span class="next ">Next</span>
{% endif %}
</div>
{% endraw %}
<div class="note warning"> <h5>Beware the page one edge-case</h5> <p> Jekyll does not generate a ‘page1’ folder, so the above code will not work when a <code>/page1</code> link is produced. See below for a way to handle this if it’s a problem for you. </p> </div>The following HTML snippet should handle page one, and render a list of each page with links to all but the current page.
{% raw %}
{% if paginator.total_pages > 1 %}
<div class="pagination">
{% if paginator.previous_page %}
<a href="{{ paginator.previous_page_path | relative_url }}">« Prev</a>
{% else %}
<span>« Prev</span>
{% endif %}
{% for page in (1..paginator.total_pages) %}
{% if page == paginator.page %}
<em>{{ page }}</em>
{% elsif page == 1 %}
<a href="{{ site.paginate_path | relative_url | replace: 'page:num/', '' }}">{{ page }}</a>
{% else %}
<a href="{{ site.paginate_path | relative_url | replace: ':num', page }}">{{ page }}</a>
{% endif %}
{% endfor %}
{% if paginator.next_page %}
<a href="{{ paginator.next_page_path | relative_url }}">Next »</a>
{% else %}
<span>Next »</span>
{% endif %}
</div>
{% endif %}
{% endraw %}