Improved pagination support

[devknoll]

• Exposed some properties in Page that weren't previously available.
• Folded in jekyll-pagination to support non-Index.html pagination and allowing for paginating files in sub-directories (e.g. /blog/index.html)
  • Defaults to index.html for backward compatibility.
• Allow for customizing the pagination url style (e.g. /blog/page/:page => /blog/page/1).
  • Defaults to page:page (page#) for backward compatibility.

[craig552uk]

+1 for non-index.html pagination.

[Stiivi]

+1 for customizing pagination URL style. It would be great if I can have project site landing page to be 'about the project' and then to have blog in a sub-directory as '/blog/*'.

[dnadlinger]

A lot of people (including me) have been using custom hacks for pagination in subdirectories – I'd love to have it available by default.

[nathggns]

How has this not been accepted yet?!?!?!?

[ghost]

@nathggns if you havent noticed there are over 200 issues on this repo, and not a commit in 2 months. I would suggest using a fork or making your own.

[nathggns]

@svnpenn How would I go about doing this? Like many others, I installed Jekyll with gem install jekyll. I have no idea how to use a different fork.

[devknoll]

If you just want these changes, you can drop the modified pagination.rb and page.rb into your _plugins folder and they will just work. Keep in mind that this won't work with GitHub Pages.

[nathggns]

@devknoll Thanks, but I noticed it doesn't work plug and play. What extra work do I have to do? I put that in plugins and it actually broke page1 (blog/index.html)

[ghost]

If you just want these changes, you can drop the modified pagination.rb and page.rb into your _plugins folder and they will just work. Keep in mind that this won't work with GitHub Pages.

That is incorrect. It will work with GitHub pages, as long as you dont rely on GitHub's Jekyll to do the transforming.

[cpence]

This would be a great addition! Category pagination seems to be one of the most commonly requested features, and this is a pretty seamless way to get it working.

[mwinckler]

In my installation, I had to change this to File.join(page.source_dir instead of page.dir. This was for paginating blog/index.html; as-is it kept generating the page2 folder in the root directory instead of in blog/, as page.dir just returned /. I'm new to Jekyll so I'm not sure if this is a bug with the patch or a bug in my setup or configuration.

[joshferrara]

+1 on pagination in subdirectories. I host my jekyll blog with gh-pages, so to have this in by default would be great.

[aaronmoodie]

+1 on this as well.

[mhumeSF]

+1 for customizing pagination URL style

[yanping]

+1 for pagination in subdirectories

[bcomnes]

I would really like to see this. Every way around this limitation feels like a hack, or plugin.

[thomasgilgenast]

+1 for pagination in subdirectories

[lewtds]

Oh @mojombo please merge this :(

[nimbupani]

I want these features, but I am no expert on whether this code is worthy or not. But I would love to have this feature available for my github pages blog!

[parkr]

@devknoll You must add tests before this will be considered for integration into the project. Thanks for the hard work, though.

[parkr]

@nimbupani The status of this repository and that of GitHub Pages have little to to with one another.

[bcomnes]

One workaround to have a paginated blog on a different page than the index with the restrictions of gh-pages is to have your main, non-paginated website pages in your [username].github.com repository, then your paginated blog in a separate repository with the name of whatever sub-page you want your paginated blog under. IE:

This is the main landing page + any other pages: https://github.com/username/username.github.com
And this would be your paginated blog index: https://github.com/username/blog (gh-pages branch)
Don't forget to provide links between the two on each site!

The second website should respect your CNAME that is set in [username].github.com and work seamlessly with that repository. There might even be some creative room for submodules in this mix.

Inspiration for this idea came from how https://github.com/yihui/yihui.github.com deals with two separate languages on his website.

Technically, its two separate sites, but if you want additional pages paginated, and you don't want to use plugins or are deploying to gh-pages, then this works right now.

It would be nice to be able to arbitrarily paginate sections of a site, IE paginated blog index that isn't the main index while also paginating other pages on the same website like an archives page. Octopress has some really basic support for this kind of thing.

[nimbupani]

Sure. But if it were in the core and if Github Pages were upgraded then
I would have some chance of using it :) For anything, is the first step
not to have it as part of Jekyll?

[parkr]

Yeppers.

This will require tests so we don't break it in the future.

[plc]

it seems like custom pagination urls were added, but not the ability to paginate content on pages other than the main index.html, for example blog/index.html does not respect the paginate_path – it defaults to blog/page2.

[parkr]

The modifications to Page that you made here were merged in #536.

@mojombo, what do think about the rest of the changes?

[Karmac]

I can use paginate_path to change the path, but how can I change the index.html file name inside of them?
Thanks.

[plc]

any updates on this? my paginated generated pages don't use the correct layout

[parkr]

Re-done on #936.