https://github.com/santosh0705/jekyll-paginate-simplecategory
Simple Pagination Generator for Jekyll Posts Categories
https://github.com/santosh0705/jekyll-paginate-simplecategory
jekyll jekyll-plugin ruby rubygem
Last synced: 3 months ago
JSON representation
Simple Pagination Generator for Jekyll Posts Categories
- Host: GitHub
- URL: https://github.com/santosh0705/jekyll-paginate-simplecategory
- Owner: santosh0705
- License: mit
- Created: 2017-06-19T09:25:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-19T10:36:18.000Z (about 9 years ago)
- Last Synced: 2025-10-07T21:43:48.732Z (9 months ago)
- Topics: jekyll, jekyll-plugin, ruby, rubygem
- Language: Ruby
- Size: 2.93 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jekyll::Paginate::Simplecategory
Simple Pagination Generator for Jekyll Posts Categories
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'jekyll-paginate-simplecategory'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-paginate-simplecategory
## Usage
### Config Example
Example of `_config.yml` file:
```yaml
# Plugins
gems:
- jekyll-paginate
- jekyll-paginate-simplecategory
# Pagination
paginate: 5
paginate_path: "/blog/page:num"
category_paginate_path: "/blog/:categories/page:num"
```
### Customization
#### Layout
Simplecategory uses the default layout template set for pagination configured in the `paginate_path` parameter. To change the default layout add the `category_layout` parameter in `_config.yml` file:
```yaml
# Pagination
category_layout: "category.html"
```
Create the layout file `category.html` in `_layout` directory. If you are placing the layout file in any other directory than put the relative path of the file as below.
```yaml
# Pagination
category_layout: "/my_layouts/category.html"
```
#### Other
You can set a custom title for each pages by adding the `category_page_title` parameter in `_config.yml` file:
```yaml
# Pagination
category_page_title: "My Blog - :categories - Page:num"
```
## Contributing
Feel free to report any bug and/or submit any improvement pull requests.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).