https://github.com/jsdoc2md/jsdoc-to-markdown

Generate markdown documentation from jsdoc-annotated javascript
https://github.com/jsdoc2md/jsdoc-to-markdown

api-documentation documentation documentation-generator documentation-tool generator jsdoc jsdoc-to-markdown markdown readme

Last synced: 4 days ago
JSON representation

Generate markdown documentation from jsdoc-annotated javascript

• Host: GitHub
• URL: https://github.com/jsdoc2md/jsdoc-to-markdown
• Owner: jsdoc2md
• License: mit
• Created: 2014-05-15T19:04:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-19T21:31:55.000Z (about 2 months ago)
• Last Synced: 2024-10-29T15:01:05.016Z (about 2 months ago)
• Topics: api-documentation, documentation, documentation-generator, documentation-tool, generator, jsdoc, jsdoc-to-markdown, markdown, readme
• Language: JavaScript
• Homepage:
• Size: 1.78 MB
• Stars: 1,687
• Watchers: 15
• Forks: 151
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![view on npm](https://badgen.net/npm/v/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown)

[![npm module downloads](https://badgen.net/npm/dt/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown)

[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=REPOSITORY)

[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=PACKAGE)

[![Node.js CI](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

_Upgraders, please read the [release notes](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)_

# jsdoc-to-markdown

Generates markdown API documentation from [jsdoc](https://jsdoc.app) annotated source code. Useful for injecting API docs into project README files.

## Synopsis

1\. Document your code using valid jsdoc comments.

```js

/**

 * A quite wonderful function.

 * @param {object} - Privacy gown

 * @param {object} - Security

 * @returns {survival}

 */

function protection (cloak, dagger) {}

```

2\. Run a command.

```sh

$ jsdoc2md example.js

```

3\. Get markdown output.

```markdown

## protection(cloak, dagger) ⇒ survival

A quite wonderful function.

**Kind**: global function

| Param  | Type                | Description  |

| ------ | ------------------- | ------------ |

| cloak  | object | Privacy gown |

| dagger | object | Security     |

```

## Install

```

$ npm install --save-dev jsdoc-to-markdown

```

## See also

* [API documentation](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)

* The [wiki](https://github.com/jsdoc2md/jsdoc-to-markdown/wiki) for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.

* * *

© 2014-24 Lloyd Brookes \.

Tested by [test-runner](https://github.com/test-runner-js/test-runner).