AST-based comments
gen-comments reads JavaScript and TypeScript syntax trees, then writes stable JSDoc blocks for named declarations.
No AI. No LLM. No surprises.
What is jsdoc-scribe?
Generate JSDoc from the AST, validate it in CI, and publish a static documentation site without AI, network calls, or runtime surprises.
2 CLIs
0 AI calls
234 tests
Integration preview
Add JSDoc without hand-writing boilerplate.
npx gen-comments src --write
Scanning 42 source filesInserted 128 deterministic blocks0 network calls, 0 prompts
Turn source comments into static HTML.
npx gen-docs src --out docs --title "My API"
Extracted modulesBuilt searchable pagesReady for GitHub Pages
Fail pull requests when documentation drifts.
npx gen-comments src --check-drift
Checked AST signaturesCompared existing JSDocExit code is CI-friendly
Built for teams
Document code without changing how your project ships.
Static docs site
gen-docs builds a searchable multi-page HTML reference from documented source files.
CI-ready checks
Use check, drift, lint, and fix modes as plain exit-code based gates in GitHub Actions.
ESLint integration
The companion ESLint plugin exposes jsdoc-scribe lint rules inside existing flat-config projects.
Ship path