This package has been deprecated

Author message:

This module is dead, it does not work with the latest jsdoc-to-markdown or dmd.

dmd-examples-highlight

DEPRECATED.

This module is dead, it does not work with the latest jsdoc-to-markdown or dmd.

dmd-examples-highlight

Overrides the default examples template, wrapping @example content with syntax highlighting.

Install

In the project that requires documenting, install as a devDependency:

$ npm install dmd-examples-highlight --save-dev

Usage

$ jsdoc2md --plugin dmd-examples-highlight --src your/code/*.js

By default, @examples will be highlighted as javascript. To override this, pass the --highlight option:

$ jsdoc2md --plugin dmd-examples-highlight --highlight ruby --src your/code/*.js

documented by jsdoc-to-markdown