Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.17 KB

README.md

File metadata and controls

24 lines (16 loc) · 1.17 KB

view on npm npm module downloads Gihub repo dependents Gihub package dependents js-standard-style

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