jsdoc-to-markdown
Generates markdown API documentation from jsdoc annotated source code
Last updated 2 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 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-19 Lloyd Brookes 75pound@gmail.com.

Current Tags

  • 5.0.0-node12.1                                ...           jsdoc-next (2 months ago)
  • 5.0.0                                ...           latest (2 months ago)

108 Versions

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

Copyright 2014 - 2016 © taobao.org |