Wondering what’s next for npm?Check out our public roadmap! »

jsdoc-to-markdown
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/jsdoc-to-markdown package

6.0.1 • Public • Published

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

Install

npm i [email protected]

Version

6.0.1

License

MIT

Unpacked Size

23.1 kB

Total Files

8

Last publish

Collaborators

  • avatar