verb-defaults

Plugin for setting basic defaults in verb projects.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
verb-defaults
400.3.06 years ago7 years agoMinified + gzip package size for verb-defaults in KB

Readme

verb-defaults NPM version NPM downloads Build Status
Plugin for setting basic defaults in verb projects.
You might also be interested in generate.

Install

Install with npm:
$ npm install --save verb-defaults

What does this do?

Default engine
Adds a default template engine for rendering templates. This engine is registered with the name *.
In a vinyl stream, to force rendering to use this engine, do:
app.src('*.md')
  .pipe(app.renderFile('*')) //<= engine name

Common middleware
Registers the common-middleware plugin, which runs preRender, posRender and preWrite middleware that handle escaping and unescaping of templates/delimiters that should not be evaluated at render time (e.g. when writing documentation it's common to have examples of templates that should not be rendered).

Usage

This plugin can be used in a verbfile.js or a globally installed verb generator.
var defaults = require('verb-defaults');

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

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-collections: Verb plugin that adds includes, layouts, badges and docs template collections. Can be used with… more | homepage
  • verb-repo-data: Verb plugin that adds repository and package.json data to the context for rendering templates. | 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 document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb
:
$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:
$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb-generate-readme
, v0.1.28, on August 06, 2016.