Jsdoc-to-markdown NPM

jsdoc-to-markdown

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

carpal class-build @barchart/barchart-documentation unqork-diez-targets abm-components-docs @elliottkember/electron-builder greygoos arborea megatank58-docgen es6-workflow ramda-redux @everything-registry/sub-chunk-1980 explain_me clear_concise_creative destiny.js-docgen simple-easy-node scope-intro sfmc-boilerplate druxt-docgen dsd-client-conn-lib simry sipa edu-doc-tool snowdev ermrestjs stencila-docket emdaer eos-wallet-js docnator doculatte react-open-weather-icons discord.js-bycon discordjs-con-self ramster @dhis2/cli-utils-docsite rainie-doc @diez/targets @discordjs/docgen @damienmortini/generator redux-easy-async referencer ecc-gulp-tasks dmd-bono dmd-grunt-jsdoc2md doccomentation oneweigh cancellation-context calculator-easy @barchart/documentation-generator cartodb-layers poly-js-utils pm-msg core-commons classy-pay-client chasejia_js-vitepress @cursorsdottsx/docgen cpt-weigh async-endpoint nw-abtest nw-dialog1 nwe pragma-storage ct-mapapps-gulp-js d3plus-dev @design-express/node-scripts betaseries-api-redux-sdk @alu0101216829/espree-logging nos-uploader begin-linting @alu0100953275/espree-logging @alu0101436784/espree-logging @adrian-alu0101024363/constant-folding @adrian-alu0101024363/spread barchart-market-data-api barchart-ondemand-market-data-api @4lch4/discord.js-docgen npm-hublo-test npm-medgo-test flexshare striim-sdk thought-plugin-jsdoc @ethereansos/interfaces-core cruller-docs @edgeros/fs-async @eccenca/gulp-tasks @environment-safe/jsdoc-builder @pleasure-js/docs @pressdocs/lang-js @plugify/docgen @playerself/sdk @pkb/cli @rsksmart/rskjs-jsdoc2md @rianbotha/js-doc-md @nkmjs/core-dev @sjukanti/optiontrader @rck-dev/vuepress-jsdoc @openfn/buildtools @openhat/cli-utils-docsite al-file-upload @studyportals/jsdoc-to-markdown

3 months ago

1 year ago

2 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

jsdoc-to-markdown v8.0.1

jsdoc-to-markdown

jsdoc-to-markdown

Synopsis

Install

See also