npm.devtool.tech
👏 You can access jsdoc-to-markdown package with using jsdocToMarkdown variable in browser devtools!
Generates markdown API documentation from jsdoc annotated source code

code/package/bundle size

0B
publish
0B
install
0B
bundle minified
0B
bundle gzipped

view on npm npm module downloads Gihub repo dependents Gihub package dependents Build Status Coverage Status js-standard-style Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

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-21 Lloyd Brookes <75pound@gmail.com>.

Tested by test-runner.

🔎Explore Package🔎CDN Script

Score

Popularity34/100
Quality98/100
Maintenance66/100