Template helper for automatically generating API docs from code comments. Should work with any template engine.
Install with npm
$ npm i helper-apidocs --save
With Lo-Dash or Underscore:
With Verb (lo-dash, with special delimiters to avoid delimiter collision in markdown docs):
Register the helper
This should work with any engine, here are a few examples
Register the helper for use with any template engine
To register the helper for use with assemblev0.6.x:
Register the helper for use with verb:
var verb = ;verb;verb;
var handlebars = ;handlebars;
// as a mixin_;_;// passed on the context_;// as an importvar settings = imports: apidocs: apidocsHelper;_;
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Copyright © 2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb on December 14, 2015.