Documentation

Programmatic API

Call jsdoc-scribe from Node when a script or tool needs direct control.

Comments API

Use the root export for comment generation and file analysis.

const { processFile, analyseFile, collectFiles } = require('jsdoc-scribe');

await processFile('src/auth.ts', { write: true });

Use the docs subpath to extract module data or build pages.

const { generateSite, extractModule } = require('jsdoc-scribe/docs');

const pages = await generateSite(['src'], { projectName: 'My Project' });

Use the lint subpath when you want to run the same validations in a custom pipeline.

const { lintModule } = require('jsdoc-scribe/lint');

const issues = lintModule(moduleData);