📝 Documentation
v1.0.0📝 Documentation
Markdown Docs Generator — Auto TypeScript API Reference
Zero-dependency TypeScript & JSDoc parser compiling comments into structured Markdown API documentation.
Zero-dependency TypeScript & JSDoc comment parser that compiles code comments into GitHub-flavored Markdown API reference documentation. Parses @param, @returns, @example, @deprecated, @throws, and complex generics. Features Table of Contents anchor generation and live --watch mode.
Key Capabilities & Architecture
Zero Dependencies
Operates with 100% native Node.js built-ins. Instant installation and fast compilation.
Live Watch Mode
Watches your source directory and automatically regenerates Markdown documentation on file save.
Quick Setup & Installation Instructions
- Zero installation needed (pure Node.js built-ins)
- Generate API docs: node generator.js --input ./src --output API_DOCUMENTATION.md
- Enable auto-watch mode: node generator.js --input ./src --output API_DOCUMENTATION.md --watch
Verified Compatibility & Requirements
✓ Node.js 18+ LTS✓ TypeScript 4.x / 5.x✓ Standard JSDoc & TSDoc formats✓ Zero external dependencies required
₹10
One-time purchase • Unlimited commercial use • Instant download
Instant ZIP package delivery after checkout
Encrypted token download link (active 48h)
Verified secure checkout via Razorpay
Full source code with zero obfuscation
🔒 256-bit encrypted transaction • Official QorelySofts digital license
Included in Your Download ZIP
- └─generator.js
- └─example/sample-source.ts
- └─example/sample-output.md
- └─package.json
- └─README.md
Frequently Asked Questions
Technical specifics and licensing details for this product.
Does it parse TypeScript interfaces?
Yes. It parses functions, classes, interfaces, and type aliases.