dmd-readable

Dmd Readable

A plugin for dmd and jsdoc-to-markdown to provide more readable docs

Installation

npm install dmd-readable

Usage

Pass the plug-in name to jsdoc2md or dmd:

jsdoc2md --plugin dmd-readable

This plugin (which was used to generate this readme) does a few things:

• removes global indexes
• places descriptions in block-quotes
• adds more whitespace before headings
• changes the delimiter for multiple types in param tables to a comma
• adds alias output

Use @summary for descriptions without block quotes.

package(key) ⇒ *

Reads info from the package.json file.

See: docs.hbs for an example of how to use this function

Param	Type	Description
key	string	The package property you want returned

changeCase(to, string) ⇒ string

Implements the library change-case.

See: docs.hbs for an example of how to use this function

Param	Type	Description
to	string	Shorthand or full name for the change-case function.
string	string	The string to modify

prefixLines(string, replacer) ⇒ string

Prefixes a string to the beginning of each line in the first string

Param	Type	Description
string	string	The string to modify
replacer	string	The string to prefix to each line