https://github.com/jsdoc2md/dmd-plugin-example

A example dmd plug-in and boilerplate
https://github.com/jsdoc2md/dmd-plugin-example

Last synced: about 1 year ago
JSON representation

A example dmd plug-in and boilerplate

• Host: GitHub
• URL: https://github.com/jsdoc2md/dmd-plugin-example
• Owner: jsdoc2md
• Created: 2015-03-01T14:52:20.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-09-06T11:12:40.000Z (over 1 year ago)
• Last Synced: 2025-02-15T01:17:04.396Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
[![view on npm](https://badgen.net/npm/v/dmd-plugin-example)](https://www.npmjs.org/package/dmd-plugin-example)

[![npm module downloads](https://badgen.net/npm/dt/dmd-plugin-example)](https://www.npmjs.org/package/dmd-plugin-example)

[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/dmd-plugin-example)](https://github.com/jsdoc2md/dmd-plugin-example/network/dependents?dependent_type=REPOSITORY)

[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/dmd-plugin-example)](https://github.com/jsdoc2md/dmd-plugin-example/network/dependents?dependent_type=PACKAGE)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# 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 

```