/dmd-plugin-example

A example dmd plug-in and boilerplate

Primary LanguageJavaScript

view on npm npm module downloads per month Dependency Status

dmd-plugin-example

This is a simple example demonstrating how to construct a dmd plugin. It adds a generated date to the bottom of your API docs.

To make your own plug-in, clone this project, edit and publish to npm.

To use a plug-in in your project, first install it as a devDependency:

$ npm install dmd-plugin-example --save-dev

Then pass the plug-in name to jsdoc2md or dmd:

$ jsdoc2md --plugin dmd-plugin-example lib/*.js