Page 2 of 10 | View as a single page
Why use this?
- You want to split long posts and pages/articles/reviews, etc. into multiple pages, e.g. chapters;
- You want to offer faster loading times to your readers;
- You want to make slide/presentation-type content (see demo!)
- You want more ad revenue from your Jekyll site;
- You wanna be the cool kid.
What’s new?
v1.1.0 Layout overrides for e.g. slides; regenerate and other fixes
v1.0.4 Allow inclusion in _config.yml
plugins
v1.0.3 Bugfixes; force option
v1.0.2 Don’t regenerate unnecessarily
Installation
Add the gem to your application’s Gemfile:
group :jekyll_plugins do
# other plugins here
gem 'jekyll-paginate-content'
end
And then execute:
$ bundle
Or install it yourself:
$ gem install jekyll-paginate-content
Configuration
No configuration is required to run Jekyll::Paginate::Content. If you want to tweak its behavior, you may set the following options in _config.yml
:
paginate_content:
#enabled: false # Default: true
debug: true # Show additional messages during run; default: false
#collection: pages, "articles" # Which collections to paginate; default: pages and posts
collections: # Ditto, just a different way of writing it
- pages # Quotes are optional if collection names are obviously strings
- posts
- articles
auto: true # Set to true to search for the page separator even if you
# don't set paginate: true in the front-matter
# Default: false
force: true # Set to true to force regeneration of pages; default: false
separator: "<!--split-->" # The page separator; default: "<!--page-->"
# Can be "h1" to "h6" for automatic splitting
# Note: Setext (underline titles) only supports h1 and h2
header: "<!--head-->" # The header separator; default: "<!--page_header-->"
footer: "<!--foot-->" # The footer separator; default: "<!--page_footer-->"
permalink: '/borg:numof:max.html' # Relative path to the new pages; default: "/:num/"
# :num will be replaced by the current page number
# :max will be replaced by the total number of page parts
# e.g. /borg7of9.html
single_page: '/full.html' # Relative path to the single-page view; default: "/view-all/"
# Set to "" for no single page view
minimum: 1000 # Minimum number of characters (including markup) in a page
# for automatic header splitting.
# If a section is too short, the next section will be merged
# Default: none
title: ':title - :num/:max' # Title format of the split pages, default: original title
# :num and :max are as in permalink,
# :title is the original title
# :section is the text of the first header
retitle_first: true # Should the first part be retitled too? Default: false
trail: # The page trail settings: number of pages to list
before: 3 # before and after the current page
after: 3 # Omit or set to 0 for all pages (default)
seo_canonical: false # Set link ref="canonical" to the view-all page; default: true
prepend_baseurl: false # Prepend the site.baseurl to paths; default: true
#properties: # Set properties per type of page, see below
# all:
# field1: value1
# # ...etc...
# first:
# field2: value2
# # ...etc...
# part:
# field3: value3
# # ...etc...
# last:
# field4: value4
# # ...etc...
# single:
# field5: value5
# # ...etc...
Here’s a cleaned-up version with the defaults:
paginate_content:
#enabled: true
#debug: false
#collections:
# - pages
# - posts
#auto: false
#separator: "<!--page-->"
#header: "<!--page_header-->"
#footer: "<!--page_footer-->"
#permalink: '/:num/"
#single_page: '/view-all/'
#minimum: 0
#title: ':title'
#retitle_first: false
#trail:
# before: 0
# after: 0
#seo_canonical: true
#prepend_baseurl: true
#properties:
# all:
# first:
# part:
# last:
# single:
Next:
Usage »