Skip to content

Verb plugin that adds includes, layouts, badges and docs template collections. Can be used with verb, assemble or generate, in a `___file.js`, or a globally installed generator.

License

Notifications You must be signed in to change notification settings

verbose/verb-collections

Repository files navigation

verb-collections NPM version NPM monthly downloads NPM total downloads Linux Build Status

Verb plugin that adds includes, layouts, badges and docs template collections. Can be used with verb, assemble or generate, in a *file.js, or a globally installed generator.

Table of Contents - [Install](#install) - [Usage](#usage) - [Collections](#collections) - [About](#about)

Install

Install with npm:

$ npm install --save verb-collections

Usage

This plugin can be used in a verbfile.js or a globally installed verb generator.

var collections = require('verb-collections');

// register the plugin
app.use(collections());

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

About

Related projects

  • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
  • generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
  • verb-readme-generator: Generate your project's readme with verb. Requires verb v0.9.0 or higher. | 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

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. MIT


This file was generated by verb-generate-readme, v0.4.1, on January 27, 2017.

About

Verb plugin that adds includes, layouts, badges and docs template collections. Can be used with verb, assemble or generate, in a `___file.js`, or a globally installed generator.

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  
  •  

Packages

No packages published