Default template used by js-comments and helper-apidocs for generating API docs.
npm install js-comments-template> Default template used by js-comments and helper-apidocs for generating API docs.
Install with npm:
``sh`
$ npm install --save js-comments-template
The comment template creates a comment section in a markdown document, with any or all of the following sub-sections (sub-sections only render if defined in the comment):
* heading: section title/heading, linked to the actual code on GitHub associated with the comment. Heading can be set explicity with a @name tag.params
* : A list of parameters and descriptions, defined with the @param tag.examples
* : gfm formatted code blocks, defined in a block comment using gfm syntax.returns
* : a return statement, defined with the @return tagevents
* : any events emitted, defined with the @emits tag
Rendered markdown
Returns true if a plugin has already been registered on an instance. This is optionally used by plugin implementors to prevent plugins from being called on an instanced more than once.
Events
* emits: plugin with registered and the name of the plugin as arguments.
Params
* name {String}: The plugin name.returns
* {Boolean}: Returns true when a plugin is already registered.
Example
`js`
var base = new Base();
base.use(function(app) {
if (app.isRegistered('myPlugin')) {
return;
}
// do stuff
});
Thousands of projects use this template. Here are a few examples:
* assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
* base-cli: Plugin for base-methods that maps built-in methods to CLI args (also supports methods from a… more | homepage
* base-config: base-methods plugin that adds a config method for mapping declarative configuration values to other 'base… more | configoption method for mapping declarative configuration values to other 'base' methods or custom functions."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* base-options: Adds a few options methods to base-methods, like , enable and disable. See the readme… more | option, enable and disable. See the readme for the full API."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* base-pipeline: base-methods plugin that adds pipeline and plugin methods for dynamically composing streaming plugin pipelines. | homepage
* base-plugins: Upgrade's plugin support in base applications to allow plugins to be called any time after… more | homepage
* base-store: Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object… more | homepage
* base-tasks: base-methods plugin that provides a very thin wrapper around https://github.com/jonschlinkert/composer for adding task methods to… more | for adding task methods to your application."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | set, get, del and use."" class="text-primary hover:underline" target="_blank" rel="noopener noreferrer">homepage
* boilerplate: Tools and conventions for authoring and using declarative configurations for project "boilerplates" that can be… more | homepage
* generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
* scaffold: Conventions and API for creating declarative configuration objects for project scaffolds - similar in format… more | homepage
* esprima-extract-comments: Extract code comments from string or from a glob of files using esprima. | homepage
* extract-comments: Uses esprima to extract line and block comments from a string of JavaScript. Also optionally… more | homepage.")
* gfm-code-blocks: Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string. | homepage fenced code blocks from a string.")
* helper-apidocs: Template helper for automatically generating API docs from code comments. Should work with any template… more | homepage
* js-comments: Parse JavaScript code comments and generate API documentation. | homepage
* parse-code-context: Parse code context in a single line of javascript, for functions, variable declarations, methods, prototype… more | homepage
* parse-comments: Parse code comments from JavaScript or any language that uses the same format. | homepage
* verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor
|
| --- | --- |
| 30 | jonschlinkert |
| 1 | tunnckoCore |
_(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)_
To generate the readme and API documentation with verb:
`sh`
$ npm install -g verb verb-generate-readme && verb
Install dev dependencies:
`sh``
$ npm install -d && npm test
Jon Schlinkert
* github/jonschlinkert
* twitter/jonschlinkert
Copyright © 2016, Jon Schlinkert.
Released under the MIT license.
*
_This file was generated by verb-generate-readme, v0.2.0, on December 13, 2016._