Package Exports

generate-collections

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generate-collections) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

generate-collections

Add the docs, includes, badges, and layouts collections, along with a few generic defaults to your generator.

You might also be interested in generate-defaults.

Install

Install as a devDependency with npm:

$ npm install generate-collections --save-dev

Usage

This plugin can be used with:

generate: in your local generator.js file or globally installed generate generator.
assemble: in your local assemblefile.js file or globally installed assemble generator.
update: in your local updatefile.js file or globally installed update generator.
verb: in your local verbfile.js file or globally installed verb generator.

generator example

module.exports = function(argument) {
  app.use(require('generate-collections'));
  // do stuff with collections
};

verbfile.js example

var verb = require('verb');
var app = verb();

// register the plugin
app.use(require('generate-collections'));

Included collections

Adds the following view collections to your verb app:

Renderable

Templates in these collections can be (automatically) rendered:

files

Layouts

Templates in these collections can be used as layouts:

layouts

Partials

Templates in these collections can be used as partials:

includes
badges
docs

You might also be interested in these projects:

assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
generate: Fast, composable, highly extendable project generator with a user-friendly and expressive API. | homepage
verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

This file was generated by verb, v, on March 29, 2016.