Page 1 of 9 | View as a single page

This documents JPC v1.0.3, available at GitHub and RubyGems.

Jekyll::Paginate::Content

Gem Version

You may read this documentation split across several pages.

Jekyll::Paginate::Content (JPC) is a plugin for Jekyll that automatically splits pages, posts, and other content into one or more pages. This can be at points where e.g. <!--page--> is inserted, or at the <h1> to <h6> headers. It mimics jekyll-paginate-v2 (JPv2) naming conventions and features, so if you use that, you will be in familiar territory.

Features: Automatic content splitting into several pages, single-page view, configurable permalinks, page trail/pager, SEO support, self-adjusting internal links, multipage-aware Table Of Contents.

TL;DR

Manual

---
title: "JPC demo: 3-page manual"
layout: page
paginate: true
---


  <a href="/jpc/readme/view-all/">View as a single page</a>


This shows up at the top of all pages.

<!--page_header-->

This is page 1 of the JPC example.

<a name="lorem"></a>Lorem ipsum dolor...

<!--page-->
This is page 2 with a [link] to the first page which works in single or paged view.


<p><a href="/jpc/readme/2/">Go on to page 2</a></p>


<!--page-->
This is the last page.

<!--page_footer-->
This goes into the bottom of all pages.

[link]: #lorem

Live demo

Automatic, with config overrides and mixed syntax

---
title: "JPC demo: 3-page auto, mixed syntax"
layout: page
paginate: true
paginate_content:
  separator: h2
  title: ":title :num/:max: :section"
  permalink: /page:numof:max.html
---

<h2>Introduction</h2>
Hello!

## What did something?
The quick brown fox...

What did it do?
---------------
...jumped over the lazy dog.

<!--page_footer-->
<div>



  <a href="/jpc/readme/2/">Why use this?</a> &raquo;

</div>

Live demo

See other demos.

Next: Why use this? »
1 2 3 4 5