helper-apidocs  

> Template helper for automatically generating API docs from code comments. Should work with any template engine.

Install

Install with npm

``sh
$ npm i helper-apidocs --save
`

Example usage

With Lo-Dash or Underscore:

`js
<%= apidocs("index.js") %>
`

With Handlebars:

`handlebars
{{apidocs "index.js"}}
`

With Verb (lo-dash, with special delimiters to avoid delimiter collision in markdown docs):

`js
{%= apidocs('index.js') %};
`

Register the helper

> This should work with any engine, here are a few examples

$3

Register the helper for use with any template engine

`js
template.helper('apidocs', require('helper-apidocs'));
`

$3

To register the helper for use with assemblev0.6.x:

`js
assemble.helper('apidocs', require('helper-apidocs'));
`

$3

Register the helper for use with verb:

`js
var verb = require('verb');
verb.helper('apidocs', require('helper-apidocs'));

verb.task('default', function() {
verb.src('.verb*.md')
.pipe(verb.dest('./'));
});
`

$3

`js
var handlebars = require('handlebars');
handlebars.registerHelper('apidocs', require('helper-apidocs'));
`

$3

`js
// as a mixin
_.mixin({apidocs: apidocsHelper});
_.template('<%= _.apidocs("fixtures/*.js") %>', {});

// passed on the context
_.template('<%= apidocs("fixtures/*.js") %>', {apidocs: apidocsHelper});

// as an import
var settings = {imports: {apidocs: apidocsHelper}};
_.template('<%= apidocs("fixtures/*.js") %>', {}, settings);
`

Running tests

Install dev dependencies:

`sh
$ npm i -d && npm test
``

Contributing

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

Author

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert
Released under the MIT license.

*

_This file was generated by verb on December 14, 2015._