1. jsdoc-to-markdown
Generates markdown API documentation from jsdoc annotated source code
jsdoc-to-markdown
Package: jsdoc-to-markdown
Created by: jsdoc2md
Last modified: Wed, 31 Jan 2024 18:50:18 GMT
Version: 8.0.1
License: MIT
Downloads: 590,187
Repository: https://github.com/jsdoc2md/jsdoc-to-markdown

Install

npm install jsdoc-to-markdown
yarn add jsdoc-to-markdown

view on npm
npm module downloads
Gihub repo dependents
Gihub package dependents
Node.js CI
Coverage Status
js-standard-style

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

See also


© 2014-24 Lloyd Brookes <[email protected]>.

Tested by test-runner.

RELATED POST

10 Must-Know Windows Shortcuts That Will Save You Time

10 Must-Know Windows Shortcuts That Will Save You Time

Arrays vs Linked Lists: Which is Better for Memory Management in Data Structures?

Arrays vs Linked Lists: Which is Better for Memory Management in Data Structures?

Navigating AWS Networking: Essential Hacks for Smooth Operation

Navigating AWS Networking: Essential Hacks for Smooth Operation

Achieving Stunning Visuals with Unity's Global Illumination

Achieving Stunning Visuals with Unity's Global Illumination

Nim's Hidden Gems: Lesser-known Features for Writing Efficient Code

Nim's Hidden Gems: Lesser-known Features for Writing Efficient Code