JSDoc

Topics

Pages

• JSDoc to Markdown

Content

Byline:

An API documentation generator for JavaScript

Key links

• 🏠 Homepage: https://jsdoc.app/
• 👨‍💻 Repo:

Installation

$ npm i -D jsdoc

Usage

If you have it installed in your project or globally, or even if not installed at all.

$ npx jsdoc foo.js

Or if installed globally.

$ jsdoc foo.js

By default, output goes to out.

Override with -d OUT_DIR.