Jsdoc-to-markdown NPM

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 targetprocess-jsdoc-gen wittyflow xc-core whale-docgen-render wtc-utility-helpers xethya-extension-base thought-plugin-jsdoc vitepress-jsdoc @discordjs/docgen @draftbot/docgen @damienmortini/generator @cursorsdottsx/docgen @design-express/node-scripts @rsksmart/rskjs-jsdoc2md @pressdocs/lang-js js-build-tools jsdoc2md-webpack jsdoc2vitepress jsdoc2vuepress jsdoc2vuepress2 jsdoctoveps jsdoc-to-mdx jquery-waiter jsdoc-to-githubmd jsdoc-markdown-cli just-spa kkldsds103 striim-sdk stencila-docket tron-api-cli util.pkgwrap @adrian-alu0101024363/constant-folding @adrian-alu0101024363/spread @barchart/documentation-generator @aestrius/mmd @agds/cli-plugin-doc @alu0101216829/espree-logging @alu0100953275/espree-logging @alu0101436784/espree-logging @cask/jsdoc-to-mdx @4lch4/discord.js-docgen 1000-packages @dhis2/cli-utils-docsite @diez/targets ydoc-plugin-comment ydoc-plugin-jsdoc yms vue2do vuepress-apidoc vuepress-jsdoc websocket-libxwsj upodi-request @hperchec/vuepress-jsdoc @huksley/markdoc @hyext/ext-sdk-cli @ethereansos/interfaces-core @gik/npm @inlog/inlog-maps @mseeley/jsdoc-to-markdown @nkmjs/core-dev @environment-safe/jsdoc-builder @eccenca/gulp-tasks @edgeros/fs-async @mimik/local @intellidimension/faqtiv-agent-toolkit @j.u.p.iter/jupiter-scripts @jbkr/generate-docs @jordanebachelet/webdav-bulk-transfer @jordanebachelet/xml-split @jseeio/jsee @rck-dev/vuepress-jsdoc @pkb/cli @scalvert/readme-api-generator @openfn/buildtools @openhat/cli-utils-docsite @pleasure-js/docs @plugify/docgen @playerself/sdk @smartcloudai/cli @rianbotha/js-doc-md moe-scripts metronome-lib meta-dev mls-algotrader nautus npm-hublo-test

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

1 year ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 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

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

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

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

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

jsdoc-to-markdown v9.1.1

jsdoc-to-markdown

Synopsis

Install

See also