Templates plugin to add index views to template collections.
Install with npm
$ npm i templates-indexer --save
var indexer = require('templates-indexer');
Add addIndices to a templates collection that will add index views to the collection when given an array of pages.
Params
options {Object}options.createView {Function}: Function to create a view object for the index view being added.options.createKey {Function}: Function to create a key for the index view being added.returns {Function}: Function to use as a plugin for templatesExample
var archives = app.create('archives')
.use(indexer())
.addIndices(pages);
addIndices method decorated onto the given collection Iterators over a list of pages (built with list.paginate) and adds each page to the collection as a new index view
Params
pages {Array}: Array of pages return from list.paginatelocals {Object}: Optional locals to add to each index view.opts {Object}: Method options to override plugin options.options.createView {Function}: Function to create a view object for the index view being added.options.createKey {Function}: Function to create a key for the index view being added.returns {Object}: Returns collection to enable chainingExample
collection.addIndices(pages, locals);
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Brian Woodward
Copyright © 2015 Brian Woodward Released under the MIT license.
This file was generated by verb-cli on September 10, 2015.