Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

@godaddy/dmd

1.0.2 • Public • Published

@godaddy/dmd

NPM Version Build Status Coverage Status GitHub

Plugin for jsdoc2md with improved readability and GitHub compatibility.

This plugin borrows from dmd-readable and dmd-bitbucket with additional treatments. No HTML tags are generated within the markdown. Headers are simplified with no nested links. Content links to headers are generated with GitHub style slugs. Reference style links are used instead of being inline.

See the mock file for an example of a generated document.

Installation

Install it as a devDependency in target project:

$ npm install @godaddy/dmd --save-dev

Usage

Then pass the plugin name to jsdoc2md or dmd to generate docs:

$ jsdoc2md --plugin @godaddy/dmd --files lib/*.js

Install

npm i @godaddy/dmd

DownloadsWeekly Downloads

14

Version

1.0.2

License

MIT

Unpacked Size

23 kB

Total Files

28

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar