Security News
The Push to Ban Ransom Payments Is Gaining Momentum
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
template-helper-apidocs
Advanced tools
Readme
Template helper for automatically generating API docs from code comments. This is based on helper-apidocs, but specifically for applications built-with the Template library.
Install with npm
$ npm i template-helper-apidocs --save
(Table of contents generated by verb)
Generate API docs from code comments for any JavaScript files that match the given patterns
. Note that only code comments with @api public
will be rendered.
Params
patterns
{String}: Glob patterns for files with code comments to render.options
{Object}: Options to pass to js-comments.returns
{String}: Markdown-formatted API documentationExample
apidocs("index.js");
(this section was generated using this helper)
This helper should work with any template engine, here are a few examples
Register the helper with Template, allowing it to be used with any template engine.
template.helper('apidocs', require('template-helper-apidocs'));
Register the helper with assemblev0.6.x:
var assemble = require('assemble');
assemble.helper('apidocs', require('template-helper-apidocs'));
Register the helper with verb:
var verb = require('verb');
verb.helper('apidocs', require('template-helper-apidocs'));
Usage with handlebars
var handlebars = require('handlebars');
handlebars.registerHelper('apidocs', require('template-helper-apidocs'));
To use the helpers with 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);
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") %}
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue
To request or contribute a helper to the github.com/helpers org, please read this contributing guide to get started.
Install dev dependencies:
$ npm i -d && npm test
See the tests for actual usage examples.
Jon Schlinkert
Copyright © 2014-2015 Jon Schlinkert Released under the MIT license.
This file was generated by verb-cli on May 29, 2015.
FAQs
Template helper for automatically generating API docs from code comments. This is based on helper-apidocs, but specifically for applications built-with the Template library.
We found that template-helper-apidocs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware costs victims an estimated $30 billion per year and has gotten so out of control that global support for banning payments is gaining momentum.
Application Security
New SEC disclosure rules aim to enforce timely cyber incident reporting, but fear of job loss and inadequate resources lead to significant underreporting.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).