Metalsmith Collections Paginate
A Metalsmith plugin for paginating collections.
You should use metalsmith-pagination instead!
Installation
npm install metalsmith-collections-paginate --save
Usage
To paginate a collection of files, you need to add a property with the same collection name to the options object that you use to initialize the plugin.
CLI
Install via npm and then add metalsmith-collections-paginate
to your metalsmith.json
:
JavaScript
Install via npm, require the module and .use
the result of the function.
var paginate = ; metalsmith;
The pageMetadata
option is optional. The object passed as pageMetadata
is used as the base for any created pages metadata. This allows for adding
arbitrary metadata to the created pages like a page title variable, allowing
for more reuse of list page templates.
Template
Within the template file you specified, you will have access to a bunch of pagination specific variables:
pagination.num
- The current page number.pagination.files
- All the files on the current page, iterate over this to render the page.pagination.name
- The name of the current collection.pagination.pages
- A link to all the pages in the collection (aliased undercollection.pages
).pagination.next
- Links to the next page file, if it exists.pagination.previous
- Links to the previous page file, if it exists.
License
MIT