helper-apidocs

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

Install

Install with npm

$ npm i helper-apidocs --save

Example usage

With Lo-Dash or Underscore:

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

With Handlebars:

{{apidocs "index.js"}}

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

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

Register the helper

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

template

Register the helper for use with any template engine

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

assemble

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

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

verb

Register the helper for use with verb:

var verb = require('verb');
verb.helper('apidocs', require('helper-apidocs'));
 
verb.task('default', function() {
  verb.src('.verb*.md')
    .pipe(verb.dest('./'));
});

handlebars

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

Lo-Dash or underscore

// 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:

$ 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.