Template helper for automatically generating API docs from code comments. Should work with any template engine.
npm install helper-apidocs> Template helper for automatically generating API docs from code comments. Should work with any template engine.
Install with npm
``sh`
$ npm i helper-apidocs --save
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') %};
> This should work with any engine, here are a few examples
Register the helper for use with any template engine
`js`
template.helper('apidocs', require('helper-apidocs'));
To register the helper for use with assemblev0.6.x:
`js`
assemble.helper('apidocs', require('helper-apidocs'));
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('./'));
});
`
`js`
var handlebars = require('handlebars');
handlebars.registerHelper('apidocs', require('helper-apidocs'));
`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);
`
Install dev dependencies:
`sh``
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
*
_This file was generated by verb on December 14, 2015._