jsdoc-to-markdown
Generates markdown API documentation from jsdoc annotated source code
Last updated 8 months ago by 75lb .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install jsdoc-to-markdown 
SYNC missed versions from official npm registry.

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>.

Current Tags

  • 6.0.1                                ...           latest (8 months ago)

113 Versions

  • 6.0.1                                ...           8 months ago
  • 6.0.0                                ...           8 months ago
  • 5.0.3                                ...           a year ago
  • 5.0.2                                ...           a year ago
  • 5.0.1                                ...           a year ago
  • 5.0.0                                ...           2 years ago
  • 5.0.0-node12.1                                ...           2 years ago
  • 4.0.1                                ...           3 years ago
  • 4.0.0                                ...           3 years ago
  • 3.1.0-1                                ...           3 years ago
  • 3.0.4                                ...           3 years ago
  • 3.0.3                                ...           3 years ago
  • 3.0.2                                ...           3 years ago
  • 3.0.1                                ...           3 years ago
  • 3.1.0-0                                ...           3 years ago
  • 3.0.0                                ...           4 years ago
  • 3.0.0-0                                ...           4 years ago
  • 1.3.9                                ...           4 years ago
  • 1.3.8                                ...           4 years ago
  • 2.0.1                                ...           4 years ago
  • 2.0.0                                ...           4 years ago
  • 2.0.0-alpha.23                                ...           4 years ago
  • 2.0.0-alpha.22                                ...           4 years ago
  • 2.0.0-alpha.21                                ...           4 years ago
  • 2.0.0-alpha.20                                ...           4 years ago
  • 2.0.0-alpha.19                                ...           4 years ago
  • 2.0.0-alpha.18                                ...           4 years ago
  • 2.0.0-alpha.17                                ...           4 years ago
  • 2.0.0-alpha.16                                ...           4 years ago
  • 2.0.0-alpha.15                                ...           4 years ago
  • 2.0.0-alpha.14                                ...           4 years ago
  • 2.0.0-alpha.13                                ...           4 years ago
  • 2.0.0-alpha.12                                ...           4 years ago
  • 2.0.0-alpha.11                                ...           4 years ago
  • 2.0.0-alpha.10                                ...           4 years ago
  • 2.0.0-alpha.9                                ...           4 years ago
  • 2.0.0-alpha.8                                ...           4 years ago
  • 1.3.7                                ...           4 years ago
  • 2.0.0-alpha.7                                ...           4 years ago
  • 2.0.0-alpha.6                                ...           4 years ago
  • 2.0.0-alpha.5                                ...           4 years ago
  • 2.0.0-alpha.4                                ...           4 years ago
  • 2.0.0-alpha.3                                ...           4 years ago
  • 2.0.0-alpha.2                                ...           4 years ago
  • 2.0.0-alpha.1                                ...           4 years ago
  • 2.0.0-alpha.0                                ...           4 years ago
  • 1.3.6                                ...           5 years ago
  • 1.3.4                                ...           5 years ago
  • 1.3.3                                ...           5 years ago
  • 1.3.2                                ...           5 years ago
  • 1.3.1                                ...           5 years ago
  • 1.3.0                                ...           5 years ago
  • 1.2.1                                ...           5 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.1                                ...           6 years ago
  • 1.1.0                                ...           6 years ago
  • 1.0.3                                ...           6 years ago
  • 1.0.2                                ...           6 years ago
  • 1.0.1                                ...           6 years ago
  • 1.0.0                                ...           6 years ago
  • 0.6.4 [deprecated]           ...           6 years ago
  • 0.5.11                                ...           6 years ago
  • 0.5.10                                ...           6 years ago
  • 0.6.3 [deprecated]           ...           6 years ago
  • 0.6.2 [deprecated]           ...           6 years ago
  • 0.6.1 [deprecated]           ...           6 years ago
  • 0.6.0 [deprecated]           ...           6 years ago
  • 0.5.9                                ...           6 years ago
  • 0.5.8                                ...           6 years ago
  • 0.5.7                                ...           6 years ago
  • 0.5.6                                ...           6 years ago
  • 0.5.5                                ...           7 years ago
  • 0.5.4                                ...           7 years ago
  • 0.5.3                                ...           7 years ago
  • 0.5.2                                ...           7 years ago
  • 0.5.1                                ...           7 years ago
  • 0.5.0                                ...           7 years ago
  • 0.4.1                                ...           7 years ago
  • 0.4.0                                ...           7 years ago
  • 0.3.3                                ...           7 years ago
  • 0.3.2                                ...           7 years ago
  • 0.3.1                                ...           7 years ago
  • 0.3.0                                ...           7 years ago
  • 0.2.18                                ...           7 years ago
  • 0.2.17                                ...           7 years ago
  • 0.2.16                                ...           7 years ago
  • 0.2.15                                ...           7 years ago
  • 0.2.14                                ...           7 years ago
  • 0.2.13                                ...           7 years ago
  • 0.2.12                                ...           7 years ago
  • 0.2.11                                ...           7 years ago
  • 0.2.10                                ...           7 years ago
  • 0.2.9                                ...           7 years ago
  • 0.2.8                                ...           7 years ago
  • 0.2.7                                ...           7 years ago
  • 0.2.5                                ...           7 years ago
  • 0.2.4                                ...           7 years ago
  • 0.2.3                                ...           7 years ago
  • 0.2.2                                ...           7 years ago
  • 0.2.1                                ...           7 years ago
  • 0.2.0                                ...           7 years ago
  • 0.1.9                                ...           7 years ago
  • 0.1.8                                ...           7 years ago
  • 0.1.7                                ...           7 years ago
  • 0.1.6                                ...           7 years ago
  • 0.1.5                                ...           7 years ago
  • 0.1.4                                ...           7 years ago
  • 0.1.3                                ...           7 years ago
  • 0.1.2                                ...           7 years ago
  • 0.1.1                                ...           7 years ago
  • 0.1.0                                ...           7 years ago
  • 0.0.1                                ...           7 years ago
  • 0.0.0                                ...           7 years ago
Maintainers (1)
Downloads
Today 59
This Week 174
This Month 1,639
Last Day 68
Last Week 489
Last Month 2,724
Dependencies (7)
Dev Dependencies (2)
Dependents (238)

Copyright 2014 - 2016 © taobao.org |