Dmd Readable

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

Installation

npm install dmd-readable

About

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 (see below)
• places descriptions in block-quotes (Use @summary for descriptions without block quotes)
• adds more whitespace before headings
• changes the delimiter for multiple types in param tables to a comma
• adds alias output

The removal of global indexes is now a setting in the template. If you are using your own template and you wish to retain this feature, add the following line to your template:

{{optionSet "global-index-format" "none"~}}

All options for global-index-format are "none", "grouped", "table", "dl". Other options and more info can be found here.

This plugin also provides the following helper functions:

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 |

findBy(array, key, value) ⇒ array

Finds an object in an array with a matching key: value

| Param | Type | Description | | --- | --- | --- | | array | array | The array to search | | key | string | The key to compare | | value | string | The value to find |

replace(string, pattern, newString) ⇒ string

Calls string.replace

| Param | Type | Description | | --- | --- | --- | | string | string | The string to modify | | pattern | string | The first arg for string.replace | | newString | string | The second arg for string.replace |

isNew(string) ⇒ boolean

Determines if the provided string is truthy and is different than the string provided the previous time this function was called

| Param | Type | | --- | --- | | string | string |