agentskillexchange JSDoc JavaScript API Documentation Generator
JSDoc is the standard API documentation generator for JavaScript. It parses specially-formatted comments in JavaScript source code to produce HTML documentation pages. With 15,000+ GitHub stars and millions of npm downloads, it is the most widely adopted JavaScript documentation tool and the foundation of the JSDoc comment standard used across the entire JS ecosystem.
Installation
Use the upstream install or setup path that matches your environment:
- npm install -g jsdoc
- npm install --save-dev jsdoc
Requirements and caveats from upstream:
- JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
- To install the latest version on npm globally (might require sudo;
Basic usage or getting-started notes:
JSDoc globally or in your project's node_modules folder.
To install the latest version on npm locally and save it in your package's
Source: https://github.com/jsdoc/jsdoc
Extracted from upstream docs: https://raw.githubusercontent.com/jsdoc/jsdoc/HEAD/README.md