Quick Start

Install

Run once with npx, add it to one project, or install it globally.

npx jsdoc-scribe . --write
npm install --save-dev jsdoc-scribe
npm install -g jsdoc-scribe

Add JSDoc comments

Start with a dry run when you want to preview generated blocks.

npx gen-comments src --dry-run

When the output looks right, write the comments in place.

npx gen-comments src --write

Generate a docs site

Build static HTML into a folder that can be committed, previewed, or deployed.

npx gen-docs src --out docs --title "My Project"

Open docs/index.html locally, or deploy the folder with GitHub Pages.