Opinionated template helper that inserts a code example from a filepath.
Install with npm:
$ npm install helper-example --save
Register the helper with app (verb, assemble or templates);
app.helper('example', require('helper-example'));
To use the helper, pass the filepath of the code example to inject and the name of the module as the second argument:
<%= example("examples/foo.js", "foo-bar-baz") %>
If the contents of foo.js is something like this:
var app = require('./');
function foo(a, b, c) {
//=> do stuff with a, b, and c
return app(a, b, c);
}
foo('one', 'two', 'three');
The require('./') statement is converted to require('helper-example'):
var app = require('helper-example');
function foo(a, b, c) {
//=> do stuff with a, b, and c
return app(a, b, c);
}
foo('one', 'two', 'three');
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb, v0.9.0, on February 26, 2016.