Module: Jekyll::PaginateV2::Generator

Defined in:: lib/jekyll-paginate-v2/generator/utils.rb,
lib/jekyll-paginate-v2/generator/defaults.rb,
lib/jekyll-paginate-v2/generator/paginator.rb,
lib/jekyll-paginate-v2/generator/paginationPage.rb,
lib/jekyll-paginate-v2/generator/paginationModel.rb,
lib/jekyll-paginate-v2/generator/paginationIndexer.rb,
lib/jekyll-paginate-v2/generator/compatibilityUtils.rb,
lib/jekyll-paginate-v2/generator/paginationGenerator.rb

Defined Under Namespace

Classes: CompatibilityPaginationPage, CompatibilityUtils, PageTrail, PaginationGenerator, PaginationIndexer, PaginationModel, PaginationPage, Paginator, Utils

Constant Summary collapse

DEFAULT = The default configuration for the Paginator

{
  'enabled'      => false,
  'collection'   => 'posts',
  'offset'       => 0, # Supports skipping x number of posts from the beginning of the post list
  'per_page'     => 10,
  'permalink'    => '/page:num/', # Supports :num as customizable elements
  'title'        => ':title - page :num', # Supports :num as customizable elements
  'page_num'     => 1,
  'sort_reverse' => false,
  'sort_field'   => 'date',
  'limit'        => 0, # Limit how many content objects to paginate (default: 0, means all)
  'trail'        => { 
      'before' => 0, # Limits how many links to show before the current page in the pagination trail (0, means off, default: 0)
      'after' => 0,  # Limits how many links to show after the current page in the pagination trail (0 means off, default: 0)
  },
  'indexpage'    => nil, # The default name of the index pages
  'extension'    => 'html', # The default extension for the output pages (ignored if indexpage is nil)
  'debug'        => false, # Turns on debug output for the gem
  'legacy'       => false # Internal value, do not use (will be removed after 2018-01-01)
}