Skip to content

jsdoc2md/jsdoc-to-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Nov 28, 2024
f2719e3 · Nov 28, 2024
Oct 19, 2024
Aug 30, 2024
Sep 2, 2024
Sep 2, 2024
Aug 30, 2024
Aug 29, 2024
May 31, 2020
Nov 1, 2024
Nov 1, 2024
Sep 2, 2024
Nov 28, 2024
Nov 28, 2024

Repository files navigation

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

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-24 Lloyd Brookes <opensource@75lb.com>.

Tested by test-runner.