<!DOCTYPE HTML>
<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width,initial-scale=1">
  <meta name="generator" content="Jekyll v3.8.3">
  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
  <link rel="preconnect" href="https://fonts.gstatic.com/" crossorigin>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900">
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" />
  <link rel="stylesheet" href="/css/screen.css">
  <link rel="icon" type="image/x-icon" href="/favicon.ico">
  <!-- Begin Jekyll SEO tag v2.4.0 -->
<title>Pagination | Jekyll • Simple, blog-aware, static sites</title>
<meta name="generator" content="Jekyll v3.8.3" />
<meta property="og:title" content="Pagination" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="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." />
<meta property="og:description" content="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." />
<link rel="canonical" href="https://jekyllrb.com/docs/pagination/" />
<meta property="og:url" content="https://jekyllrb.com/docs/pagination/" />
<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2018-06-08T11:29:03-07:00" />
<meta name="twitter:card" content="summary" />
<meta name="twitter:site" content="@jekyllrb" />
<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
<script type="application/ld+json">
{"description":"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.","@type":"BlogPosting","url":"https://jekyllrb.com/docs/pagination/","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"headline":"Pagination","dateModified":"2018-06-08T11:29:03-07:00","datePublished":"2018-06-08T11:29:03-07:00","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/pagination/"},"@context":"http://schema.org"}</script>
<!-- End Jekyll SEO tag -->

  <!--[if lt IE 9]>
  <script src="/js/html5shiv.min.js"></script>
  <script src="/js/respond.min.js"></script>
  <![endif]-->
</head>


<body class="wrap">
  <header>
  <div class="flexbox">
    <div class="center-on-mobiles">
      <h1>
        <a href="/" class="logo">
          <span class="sr-only">Jekyll</span>
          <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
        </a>
      </h1>
    </div>
    <nav class="main-nav hide-on-mobiles">
      <ul>
  <li class="">
    <a href="/">Home</a>
  </li>
  <li class="current">
    <a href="/docs/home/">Docs</a>
  </li>
  <li class="">
    <a href="/news/">News</a>
  </li>
  <li class="">
    <a href="/help/">Help</a>
  </li>
</ul>

    </nav>
    <div class="search hide-on-mobiles">
      <input type="text" id="docsearch-input" placeholder="Search the docs…">

    </div>
    <div class="meta hide-on-mobiles">
      <ul>
        <li>
          <a href="https://github.com/jekyll/jekyll/releases/tag/v3.8.3">v3.8.3</a>
        </li>
        <li>
          <a href="https://github.com/jekyll/jekyll">GitHub</a>
        </li>
      </ul>
    </div>
  </div>
  <nav class="mobile-nav show-on-mobiles">
    <ul>
  <li class="">
    <a href="/">Home</a>
  </li>
  <li class="current">
    <a href="/docs/home/">Docs</a>
  </li>
  <li class="">
    <a href="/news/">News</a>
  </li>
  <li class="">
    <a href="/help/">Help</a>
  </li>
  <li>
    <a href="https://github.com/jekyll/jekyll">GitHub</a>
  </li>
</ul>

  </nav>
</header>


    <section class="docs">
    <div class="grid">

      <div class="docs-nav-mobile unit whole show-on-mobiles">
  <select onchange="if (this.value) window.location.href=this.value">
    <option value="">Navigate the docs…</option>
    
    <optgroup label="Getting Started">
      
  
  
  <option value="/docs/home/">Welcome</option>

  
  
  <option value="/docs/quickstart/">Quick-start guide</option>

  
  
  <option value="/docs/installation/">Installation</option>

  
  
  <option value="/docs/windows/">Jekyll on Windows</option>

  
  
  <option value="/docs/usage/">Basic Usage</option>

  
  
  <option value="/docs/structure/">Directory structure</option>

  
  
  <option value="/docs/configuration/">Configuration</option>


    </optgroup>
    
    <optgroup label="Your Content">
      
  
  
  <option value="/docs/frontmatter/">Front Matter</option>

  
  
  <option value="/docs/posts/">Writing posts</option>

  
  
  <option value="/docs/drafts/">Working with drafts</option>

  
  
  <option value="/docs/pages/">Creating pages</option>

  
  
  <option value="/docs/static-files/">Static Files</option>

  
  
  <option value="/docs/variables/">Variables</option>

  
  
  <option value="/docs/collections/">Collections</option>

  
  
  <option value="/docs/datafiles/">Data Files</option>

  
  
  <option value="/docs/assets/">Assets</option>

  
  
  <option value="/docs/migrations/">Blog migrations</option>


    </optgroup>
    
    <optgroup label="Customization">
      
  
  
  <option value="/docs/templates/">Templates</option>

  
  
  <option value="/docs/includes/">Includes</option>

  
  
  <option value="/docs/permalinks/">Permalinks</option>

  
  
  <option value="/docs/pagination/">Pagination</option>

  
  
  <option value="/docs/plugins/">Plugins</option>

  
  
  <option value="/docs/themes/">Themes</option>

  
  
  <option value="/docs/extras/">Extras</option>


    </optgroup>
    
    <optgroup label="Deployment">
      
  
  
  <option value="/docs/github-pages/">GitHub Pages</option>

  
  
  <option value="/docs/deployment-methods/">Deployment methods</option>

  
  
  <option value="/docs/continuous-integration/">Continuous Integration</option>


    </optgroup>
    
    <optgroup label="Miscellaneous">
      
  
  
  <option value="/docs/troubleshooting/">Troubleshooting</option>

  
  
  <option value="/docs/sites/">Sites using Jekyll</option>

  
  
  <option value="/docs/resources/">Resources</option>

  
  
  <option value="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</option>

  
  
  <option value="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</option>


    </optgroup>
    
    <optgroup label="Meta">
      
  
  
  <option value="/docs/contributing/">Contributing</option>

  
  
  <option value="/docs/maintaining/">Maintaining Jekyll</option>

  
  
  <option value="/docs/conduct/">Code of Conduct</option>

  
  
  <option value="/docs/history/">History</option>


    </optgroup>
    
  </select>
</div>


      <div class="unit four-fifths">
        <article>
          <div class="improve right hide-on-mobiles">
            <a href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/pagination.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
          </div>
          <h1>Pagination</h1>
          <p>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.</p>

<p>For Jekyll 3, include the <code class="highlighter-rouge">jekyll-paginate</code> plugin in your Gemfile and in
your <code class="highlighter-rouge">_config.yml</code> under <code class="highlighter-rouge">plugins</code>. For Jekyll 2, this is standard.</p>

<div class="note info">
  <h5>Pagination only works within HTML files</h5>
  <p>
    Pagination does not work from within Markdown or Textile files from
    your Jekyll site. Pagination works when called from within the HTML
    file, named <code>index.html</code>, which optionally may reside in and
    produce pagination from within a subdirectory, via the
    <code>paginate_path</code> configuration value.
  </p>
</div>

<h2 id="enable-pagination">Enable pagination</h2>

<p>To enable pagination for posts on your blog, add a line to the <code class="highlighter-rouge">_config.yml</code> file that
specifies how many items should be displayed per page:</p>

<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">paginate</span><span class="pi">:</span> <span class="s">5</span>
</code></pre></div></div>

<p>The number should be the maximum number of Posts you’d like to be displayed
per-page in the generated site.</p>

<p>You may also specify the destination of the pagination pages:</p>

<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">paginate_path</span><span class="pi">:</span> <span class="s2">"</span><span class="s">/blog/page:num/"</span>
</code></pre></div></div>

<p>This will read in <code class="highlighter-rouge">blog/index.html</code>, send it each pagination page in Liquid as
<code class="highlighter-rouge">paginator</code> and write the output to <code class="highlighter-rouge">blog/page:num/</code>, where <code class="highlighter-rouge">:num</code> is the
pagination page number, starting with <code class="highlighter-rouge">2</code>. If a site has 12 posts and specifies
<code class="highlighter-rouge">paginate: 5</code>, Jekyll will write <code class="highlighter-rouge">blog/index.html</code> with the first 5 posts, <code class="highlighter-rouge">blog/page2/index.html</code> with the next 5 posts
and <code class="highlighter-rouge">blog/page3/index.html</code> with the last 2 posts into the destination
directory.</p>

<div class="note warning">
  <h5>Don't set a permalink</h5>
  <p>
    Setting a permalink in the front matter of your blog page will cause
    pagination to break. Just omit the permalink.
  </p>
</div>

<div class="note info">
  <h5>Pagination for categories, tags and collections</h5>
  <p>
    The more recent <a href="https://github.com/sverrirs/jekyll-paginate-v2">jekyll-paginate-v2</a> plugin supports more features. See the <a href="https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples">pagination examples</a> in the repository.
    <strong>This plugin is not supported by GitHub Pages</strong>.
  </p>
</div>

<h2 id="liquid-attributes-available">Liquid Attributes Available</h2>

<p>The pagination plugin exposes the <code class="highlighter-rouge">paginator</code> liquid object with the following
attributes:</p>

<div class="mobile-side-scroller">
<table>
  <thead>
    <tr>
      <th>Attribute</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><p><code>page</code></p></td>
      <td><p>current page number</p></td>
    </tr>
    <tr>
      <td><p><code>per_page</code></p></td>
      <td><p>number of posts per page</p></td>
    </tr>
    <tr>
      <td><p><code>posts</code></p></td>
      <td><p>a list of posts for the current page</p></td>
    </tr>
    <tr>
      <td><p><code>total_posts</code></p></td>
      <td><p>total number of posts in the site</p></td>
    </tr>
    <tr>
      <td><p><code>total_pages</code></p></td>
      <td><p>number of pagination pages</p></td>
    </tr>
    <tr>
      <td><p><code>previous_page</code></p></td>
      <td>
          <p>
              page number of the previous pagination page,
              or <code>nil</code> if no previous page exists
          </p>
      </td>
    </tr>
    <tr>
      <td><p><code>previous_page_path</code></p></td>
      <td>
          <p>
              path of previous pagination page,
              or <code>nil</code> if no previous page exists
          </p>
      </td>
    </tr>
    <tr>
      <td><p><code>next_page</code></p></td>
      <td>
          <p>
              page number of the next pagination page,
              or <code>nil</code> if no subsequent page exists
          </p>
      </td>
    </tr>
    <tr>
      <td><p><code>next_page_path</code></p></td>
      <td>
          <p>
              path of next pagination page,
              or <code>nil</code> if no subsequent page exists
          </p>
      </td>
    </tr>
  </tbody>
</table>
</div>

<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 YAML 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>

<h2 id="render-the-paginated-posts">Render the paginated Posts</h2>

<p>The next thing you need to do is to actually display your posts in a list using
the <code class="highlighter-rouge">paginator</code> 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:</p>

<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code>---
layout: default
title: My Blog
---

&lt;!-- This loops through the paginated posts --&gt;
<span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span>post<span class="w"> </span>in<span class="w"> </span>paginator.posts<span class="w"> </span><span class="p">%}</span>
  &lt;h1&gt;&lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">url</span><span class="w"> </span><span class="p">}}</span>"&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">title</span><span class="w"> </span><span class="p">}}</span>&lt;/a&gt;&lt;/h1&gt;
  &lt;p class="author"&gt;
    &lt;span class="date"&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">date</span><span class="w"> </span><span class="p">}}</span>&lt;/span&gt;
  &lt;/p&gt;
  &lt;div class="content"&gt;
    <span class="p">{{</span><span class="w"> </span><span class="nv">post</span><span class="p">.</span><span class="nv">content</span><span class="w"> </span><span class="p">}}</span>
  &lt;/div&gt;
<span class="p">{%</span><span class="w"> </span><span class="nt">endfor</span><span class="w"> </span><span class="p">%}</span>

&lt;!-- Pagination links --&gt;
&lt;div class="pagination"&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">previous_page</span><span class="w"> </span><span class="p">%}</span>
    &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">previous_page_path</span><span class="w"> </span><span class="p">}}</span>" class="previous"&gt;Previous&lt;/a&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">else</span><span class="w"> </span><span class="p">%}</span>
    &lt;span class="previous"&gt;Previous&lt;/span&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
  &lt;span class="page_number "&gt;Page: <span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">page</span><span class="w"> </span><span class="p">}}</span> of <span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">total_pages</span><span class="w"> </span><span class="p">}}</span>&lt;/span&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">next_page</span><span class="w"> </span><span class="p">%}</span>
    &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">next_page_path</span><span class="w"> </span><span class="p">}}</span>" class="next"&gt;Next&lt;/a&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">else</span><span class="w"> </span><span class="p">%}</span>
    &lt;span class="next "&gt;Next&lt;/span&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
&lt;/div&gt;
</code></pre></div></div>

<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>

<p>The following HTML snippet should handle page one, and render a list of each
page with links to all but the current page.</p>

<div class="language-liquid highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">total_pages</span><span class="w"> </span><span class="o">&gt;</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">%}</span>
&lt;div class="pagination"&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">previous_page</span><span class="w"> </span><span class="p">%}</span>
    &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">previous_page_path</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">prepend</span><span class="p">:</span><span class="w"> </span>site.baseurl<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">replace</span><span class="p">:</span><span class="w"> </span><span class="s1">'//'</span><span class="p">,</span><span class="w"> </span><span class="s1">'/'</span><span class="w"> </span><span class="p">}}</span>"&gt;&amp;laquo; Prev&lt;/a&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">else</span><span class="w"> </span><span class="p">%}</span>
    &lt;span&gt;&amp;laquo; Prev&lt;/span&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>

  <span class="p">{%</span><span class="w"> </span><span class="nt">for</span><span class="w"> </span>page<span class="w"> </span>in<span class="w"> </span>(<span class="mi">1</span>..paginator.total_pages)<span class="w"> </span><span class="p">%}</span>
    <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">page</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">page</span><span class="w"> </span><span class="p">%}</span>
      &lt;em&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="w"> </span><span class="p">}}</span>&lt;/em&gt;
    <span class="p">{%</span><span class="w"> </span><span class="kr">elsif</span><span class="w"> </span><span class="nv">page</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">1</span><span class="w"> </span><span class="p">%}</span>
      &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">previous_page_path</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">prepend</span><span class="p">:</span><span class="w"> </span>site.baseurl<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">replace</span><span class="p">:</span><span class="w"> </span><span class="s1">'//'</span><span class="p">,</span><span class="w"> </span><span class="s1">'/'</span><span class="w"> </span><span class="p">}}</span>"&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="w"> </span><span class="p">}}</span>&lt;/a&gt;
    <span class="p">{%</span><span class="w"> </span><span class="kr">else</span><span class="w"> </span><span class="p">%}</span>
      &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">site</span><span class="p">.</span><span class="nv">paginate_path</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">prepend</span><span class="p">:</span><span class="w"> </span>site.baseurl<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">replace</span><span class="p">:</span><span class="w"> </span><span class="s1">'//'</span><span class="p">,</span><span class="w"> </span><span class="s1">'/'</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">replace</span><span class="p">:</span><span class="w"> </span><span class="s1">':num'</span><span class="p">,</span><span class="w"> </span>page<span class="w"> </span><span class="p">}}</span>"&gt;<span class="p">{{</span><span class="w"> </span><span class="nv">page</span><span class="w"> </span><span class="p">}}</span>&lt;/a&gt;
    <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
  <span class="p">{%</span><span class="w"> </span><span class="nt">endfor</span><span class="w"> </span><span class="p">%}</span>

  <span class="p">{%</span><span class="w"> </span><span class="kr">if</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">next_page</span><span class="w"> </span><span class="p">%}</span>
    &lt;a href="<span class="p">{{</span><span class="w"> </span><span class="nv">paginator</span><span class="p">.</span><span class="nv">next_page_path</span><span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">prepend</span><span class="p">:</span><span class="w"> </span>site.baseurl<span class="w"> </span><span class="p">|</span><span class="w"> </span><span class="nf">replace</span><span class="p">:</span><span class="w"> </span><span class="s1">'//'</span><span class="p">,</span><span class="w"> </span><span class="s1">'/'</span><span class="w"> </span><span class="p">}}</span>"&gt;Next &amp;raquo;&lt;/a&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">else</span><span class="w"> </span><span class="p">%}</span>
    &lt;span&gt;Next &amp;raquo;&lt;/span&gt;
  <span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
&lt;/div&gt;
<span class="p">{%</span><span class="w"> </span><span class="kr">endif</span><span class="w"> </span><span class="p">%}</span>
</code></pre></div></div>


          





  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  

  
  
    <div class="section-nav">
      <div class="left align-right">
          
            
            
            <a href="/docs/permalinks/" class="prev">Back</a>
          
      </div>
      <div class="right align-left">
          
            
            
            <a href="/docs/plugins/" class="next">Next</a>
          
      </div>
    </div>
    <div class="clear"></div>
    
        </article>
      </div>

      <div class="unit one-fifth hide-on-mobiles">
  <aside>
    
    <h4>Getting Started</h4>
    <ul>

  
  
  <li class=""><a href="/docs/home/">Welcome</a></li>

  
  
  <li class=""><a href="/docs/quickstart/">Quick-start guide</a></li>

  
  
  <li class=""><a href="/docs/installation/">Installation</a></li>

  
  
  <li class=""><a href="/docs/windows/">Jekyll on Windows</a></li>

  
  
  <li class=""><a href="/docs/usage/">Basic Usage</a></li>

  
  
  <li class=""><a href="/docs/structure/">Directory structure</a></li>

  
  
  <li class=""><a href="/docs/configuration/">Configuration</a></li>

</ul>

    
    <h4>Your Content</h4>
    <ul>

  
  
  <li class=""><a href="/docs/frontmatter/">Front Matter</a></li>

  
  
  <li class=""><a href="/docs/posts/">Writing posts</a></li>

  
  
  <li class=""><a href="/docs/drafts/">Working with drafts</a></li>

  
  
  <li class=""><a href="/docs/pages/">Creating pages</a></li>

  
  
  <li class=""><a href="/docs/static-files/">Static Files</a></li>

  
  
  <li class=""><a href="/docs/variables/">Variables</a></li>

  
  
  <li class=""><a href="/docs/collections/">Collections</a></li>

  
  
  <li class=""><a href="/docs/datafiles/">Data Files</a></li>

  
  
  <li class=""><a href="/docs/assets/">Assets</a></li>

  
  
  <li class=""><a href="/docs/migrations/">Blog migrations</a></li>

</ul>

    
    <h4>Customization</h4>
    <ul>

  
  
  <li class=""><a href="/docs/templates/">Templates</a></li>

  
  
  <li class=""><a href="/docs/includes/">Includes</a></li>

  
  
  <li class=""><a href="/docs/permalinks/">Permalinks</a></li>

  
  
  <li class="current"><a href="/docs/pagination/">Pagination</a></li>

  
  
  <li class=""><a href="/docs/plugins/">Plugins</a></li>

  
  
  <li class=""><a href="/docs/themes/">Themes</a></li>

  
  
  <li class=""><a href="/docs/extras/">Extras</a></li>

</ul>

    
    <h4>Deployment</h4>
    <ul>

  
  
  <li class=""><a href="/docs/github-pages/">GitHub Pages</a></li>

  
  
  <li class=""><a href="/docs/deployment-methods/">Deployment methods</a></li>

  
  
  <li class=""><a href="/docs/continuous-integration/">Continuous Integration</a></li>

</ul>

    
    <h4>Miscellaneous</h4>
    <ul>

  
  
  <li class=""><a href="/docs/troubleshooting/">Troubleshooting</a></li>

  
  
  <li class=""><a href="/docs/sites/">Sites using Jekyll</a></li>

  
  
  <li class=""><a href="/docs/resources/">Resources</a></li>

  
  
  <li class=""><a href="/docs/upgrading/0-to-2/">Upgrading from 0.x to 2.x</a></li>

  
  
  <li class=""><a href="/docs/upgrading/2-to-3/">Upgrading from 2.x to 3.x</a></li>

</ul>

    
    <h4>Meta</h4>
    <ul>

  
  
  <li class=""><a href="/docs/contributing/">Contributing</a></li>

  
  
  <li class=""><a href="/docs/maintaining/">Maintaining Jekyll</a></li>

  
  
  <li class=""><a href="/docs/conduct/">Code of Conduct</a></li>

  
  
  <li class=""><a href="/docs/history/">History</a></li>

</ul>

    
  </aside>
</div>


      <div class="clear"></div>

    </div>
  </section>


  <footer>
  <div class="grid">
    <div class="unit one-third center-on-mobiles">
      <p>The contents of this website are <br />&copy;&nbsp;2018 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
    </div>
    <div class="unit two-thirds align-right center-on-mobiles">
      <p>
        Proudly hosted by
        <a href="https://github.com">
          <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
        </a>
      </p>
    </div>
  </div>
</footer>

  <script>
  var anchorForId = function (id) {
    var anchor = document.createElement("a");
    anchor.className = "header-link";
    anchor.href      = "#" + id;
    anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
    anchor.title = "Permalink";
    return anchor;
  };

  var linkifyAnchors = function (level, containingElement) {
    var headers = containingElement.getElementsByTagName("h" + level);
    for (var h = 0; h < headers.length; h++) {
      var header = headers[h];

      if (typeof header.id !== "undefined" && header.id !== "") {
        header.appendChild(anchorForId(header.id));
      }
    }
  };

  document.onreadystatechange = function () {
    if (this.readyState === "complete") {
      var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
      if (!contentBlock) {
        return;
      }
      for (var level = 1; level <= 6; level++) {
        linkifyAnchors(level, contentBlock);
      }
    }
  };
</script>

  
  <!-- Google Analytics (https://www.google.com/analytics) -->
  <script>
    !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
    (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
    L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
    L.parentNode.insertBefore(l,L)}(window,document,'script','ga');

    ga('create', 'UA-50755011-1', 'jekyllrb.com');
    ga('send', 'pageview');

  </script>


  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script type="text/javascript"> docsearch({
apiKey: '50fe39c839958dfad797000f33e2ec17',
indexName: 'jekyllrb',
inputSelector: '#docsearch-input',
enhancedSearchInput: true,
debug: false // Set debug to true if you want to inspect the dropdown
});
</script>

</body>
</html>