Jsdoc To Markdown Save

Generate markdown documentation from jsdoc-annotated javascript

Project README

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI Coverage Status js-standard-style

jsdoc-to-markdown

Upgraders, please read the release notes

jsdoc-to-markdown

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


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

Tested by test-runner.

Open Source Agenda is not affiliated with "Jsdoc To Markdown" Project. README Source: jsdoc2md/jsdoc-to-markdown

Open Source Agenda Badge

Open Source Agenda Rating