jsdoc-to-markdown

Creates markdown API documentation from jsdoc-commented javascript

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

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 -g jsdoc-to-markdown

See also

© 2014-17 Lloyd Brookes [email protected].

Related Repositories

docdown

docdown

A simple JSDoc to Markdown generator. ...

command-line-args

command-line-args

A library to parse command-line options. ...

jsdoc-parse

jsdoc-parse

parses jsdoc documentation from javascript or html files, outputs JSON ...

meteor-jsdoc

meteor-jsdoc

Automated JSDoc generation for Meteor projects with a Meteor server to output th ...

docma

docma

A powerful tool to easily generate beautiful HTML documentation from Javascript ...