Powering production docs
API docs that live with your TypeScript code.
Generate always up-to-date API documentation from your codebase. Zero maintenance, fully customizable.
From source code to docs
We start with a full TypeScript reflection of your project, enhance it with purpose-built components, and give you complete control over the result.
Zero manual API docs
Point docsgen at your TypeScript source and it extracts every type, interface, class, and function automatically. You never write or update API reference pages by hand again.
Comments become docs
Your TSDoc comments flow directly into the final documentation. We extended the TSDoc format with custom tags and badges so you can enrich your API docs without leaving your source code.
Arrange it your way
Control the layout, ordering, and structure of every page. Use page templates, mapper functions, and configuration to make docs fit your project, not the other way around.
Style it your way
Every generated element has CSS classes you can override. Swap built-in components for your own, theme with your design system, or restyle individual sections - your docs, your brand.
One directive. Live docs.
Write a single @import in your MDX and get always-current API documentation rendered on every build.
Request
The Request class handles all HTTP communication with the server.
Methods
| Name | Returns | Description |
|---|---|---|
send() | Promise<Response> | Execute the request |
abort() | void | Cancel the request |
clone() | Request | Create a copy |
Everything you need
A modular toolkit for generating, embedding, and maintaining TypeScript documentation that stays in sync with your codebase.
Write once. Stay current.
You write the narrative. The code provides the details. Docsgen bridges the gap so your documentation never falls out of sync.
Always Up-to-Date
Docs auto-update when you change code. Rename a parameter, add a method - the docs reflect it on the next build.
@import Directive
Embed live API fragments - method tables, parameter lists, type definitions - directly in your hand-written MDX.
Monorepo Support
Generate docs for every package in a monorepo with cross-package type linking and a shared index page.
Fully Customizable
Control output with mapper functions, page templates, JSDoc tags, and per-package configuration.
TypeDoc Powered
Built on TypeDoc for reliable TypeScript parsing. Supports generics, overloads, decorators, and complex type hierarchies.
MDX Generation
Generates clean MDX files with frontmatter, sidebar metadata, and Docusaurus-compatible category files.
Our wonderful sponsors
We're grateful to the following companies and individuals who have supported us financially. You can still help us by joining the GitHub Sponsors program or contact us for other ways of support or collaboration.
Try Docsgen
Open source and free. Set up in minutes, keep your docs accurate forever.