@liquid-labs/jsdoc-to-markdown

This is an fork of jsdoc-to-markdown which add support for additional features and the ability to swap out the "root" plugin with another implementation. The goal is to be able support all the new features of dmd-readme-api, which adds numerous features to generated documentation including grouping of global identifiers, source code links, links from documentation back to indexes, and a generally more compact style.

See dmd-readme-api for usage.

This package is being published because a number of my other projects rely on these changes. There are pull requests for all the changes and if/when they are incorporated into the original project, this one will be deprecated. On the other hand, if the changes are not adopted, then we will continue to maintain this fork.

Generates markdown API documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.

Synopsis

1. Document your code using valid jsdoc comments.

/**
 * A quite wonderful function.
 * @param {object} - Privacy gown
 * @param {object} - Security
 * @returns {survival}
 */
function protection (cloak, dagger) {}

2. Run a command.

$ jsdoc2md example.js

3. Get markdown output.

## protection(cloak, dagger) ⇒ <code>survival</code>
A quite wonderful function.

**Kind**: global function

| Param  | Type                | Description  |
| ------ | ------------------- | ------------ |
| cloak  | <code>object</code> | Privacy gown |
| dagger | <code>object</code> | Security     |

Install

$ npm install --save-dev jsdoc-to-markdown

See also

• API documentation
• The wiki for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.

© 2014-24 Lloyd Brookes <[email protected]>.

Tested by test-runner.