The Easiest Way to Document Your Code
Just run the command below in your Typescript library and answer a few questions.mint-tsdocs will automatically detect your TypeScript project, ask a few configuration questions,
and set everything up.
If you haven’t configured your Mintlify docs yet, we’ll do that for you too!
Wanna see how good it looks?
The Reference section of this documentation was generated using
mint-tsdocsFeatures
Zero Configuration
Auto-detects your TypeScript setup and generates everything you need. Fully customizable when you want control.
Advanced Interactive Components
Beautiful Type Tree visualizations and interactive components that look native to Mintlify—not bolted on.
Auto-Generated Type Information
Stop manually documenting complex types. We extract and format TypeInfo automatically—nested objects, unions, generics, all of it.
Hands-Free Navigation
Your
docs.json updates automatically. No more manual maintenance of navigation structure.Smart Cross-References
Related API items link automatically. Your users never hit a dead end.
Always in Sync
Generated from your source code, not hand-written. When your types change, your docs reflect it.
Built on Solid Foundations
mint-tsdocs is powered by Microsoft’s excellent API Extractor and TSDoc projects, which handle the complex work of extracting and parsing TypeScript APIs. We’re grateful to the Rush Stack team for these foundational tools.Next Steps
Installation
Install and configure the tool
Quick Start
Get up and running in minutes
Architecture
Understand how it works