Pagination gem built specially for Jekyll 3 and newer that is fully backwards compatible and serves as an enhanced replacement for the previously built-in jekyll-paginate gem. View it on rubygems.org.
- Example Sites
- Pagination Generator
- Issues / to-be-completed
- How to Contribute
"Be excellent to each other"
gem install jekyll-paginate-v2
Now you're ready to run
jekyll serve and your paginated files should be generated.
Please see the Examples for tips and tricks on how to configure the pagination logic.
⚠️Please note that this plugin is currently NOT supported by GitHub pages. Here is a list of all plugins supported. There is work underway to try to get it added it but until then please follow this GitHub guide to enable it or use Travis CI.
GitLab supposedly supports any plugin.
The Pagination Generator forms the core of the pagination logic. Calculates and generates the pagination pages.
The Auto-Pages is an optional feature that auto-magically generates paginated pages for all your tags, categories and collections.
Issues / to-be-completed
- Unit-tests do not cover all critical code paths
- No integration tests yet #2
- Exclude filter not implemented #6
- Elegant way of collecting and printing debug information during pagination
I welcome all testers and people willing to give me feedback and code reviews.
Although this project is small it has a code of conduct that I hope everyone will do their best to follow when contributing to any aspects of this project. Be it discussions, issue reporting, documentation or programming.
If you don't want to open issues here on Github, send me your feedback by email at email@example.com.
- Fork it ( https://github.com/sverrirs/jekyll-paginate-v2/fork )
- Create your feature branch (
git checkout -b my-new-feature)
- Run the unit tests (
- Commit your changes (
git commit -am 'Add some feature')
- Build the gem locally (
gem build jekyll-paginate-v2.gemspec)
- Test and verify the gem locally (
gem install ./jekyll-paginate-v2-x.x.x.gem)
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Note: This project uses semantic versioning.