Skip to main content

​
Features

mint-tsdocs generates Mintlify documentation from your TypeScript code with type-safe links and interactive components.

​
What You Get

generate

Auto-generate Mintlify docs from TypeScript.
Extracts types, interfaces, classes, and functions from your TypeScript declarations and generates Mintlify MDX files with proper frontmatter, navigation, and components.

Auto-Linking

Automatically links referenced types and pages

Mintlify Components

Uses <ParamField>, <ResponseField>, <Expandable>

Navigation Sync

Updates docs.json with generated pages

Supporting Snippets

Exports TypeInfo data and component helpers
mint-tsdocs generate

RefLink & PageLink

Type-checked links with IDE autocomplete.
Auto-generates TypeScript union types for all API references and documentation pages. Get autocomplete as you type, compile errors for broken links.

IDE Autocomplete

<RefLink target="MyClass.method" /> with suggestions

Build-Time Errors

Invalid links fail at compile, not in production

Runtime Validation

Visual indicators for broken links during development

Auto-Generated Types

ValidRefs.d.ts and ValidPages.d.ts created automatically

TypeTree Component

Interactive type hierarchies for complex types.
Displays nested object properties as an expandable tree with Mintlify-native components that match your project theme.

Nested Properties

Extracts and displays deeply nested type structures

TypeInfo Export

Auto-generated TypeInfo.jsx with data for every type

Type Declarations

TypeInfo.d.ts for IDE IntelliSense

Mintlify Styled

Uses native Mintlify components for consistent theming

​
Quality Assurance

lint

Find TSDoc issues before generating.
Validates TSDoc comments for common mistakes, missing descriptions, and broken references.
mint-tsdocs lint

Comment Validation

Checks for malformed or incomplete TSDoc

Reference Checking

Finds broken @link and @see tags

coverage

Know what's documented and what's missing.
Reports documentation coverage by file, module, and API kind with configurable thresholds.
mint-tsdocs coverage

By File

See coverage for each source file

By Module

Group by package or namespace

By Kind

Filter by class, interface, function, etc.

Thresholds

Set minimum coverage requirements

​
Customization

customize

Full template control and custom styling.
Export Liquid templates for complete control over generated MDX, or just override styles with custom CSS.
mint-tsdocs customize -t ./templates

Liquid Templates

Full control over MDX structure and layout

Layout Inheritance

Extend default templates with blocks and overrides

Custom CSS

Override component styles without touching templates

Rich Data

Access all properties, methods, parameters, examples

Utility Components

Ready-to-use components for richer docs.
Additional Mintlify-compatible React components for enhanced documentation.

Preview

Bordered container with dark mode for code examples

Feature

Highlight features with icons, cards, and flexible layout
All components include TypeScript declarations for IDE support.

​
Setup

init

Zero-config project setup.
Auto-detects TypeScript entry points, docs folder, and Mintlify configuration. Creates mint-tsdocs.config.json with sensible defaults.
mint-tsdocs init

Auto-Detection

Finds TypeScript entry, docs.json, output folder

Mintlify Setup

Optionally initializes Mintlify if not present

Config Generation

Creates mint-tsdocs.config.json with detected values

Script Injection

Adds “mint-tsdocs” script to package.json

​
Ready to Try It?

Quick Start

5 minutes to first docs

See Examples

Browse generated components

GitHub

Star us on GitHub