AI Documentation for TypeScript Projects
Hosted docs for TypeScript repos. Auto-generated, auto-updated nightly. Detects tsconfig.json and typed exports.
Free for public repos. No account needed.
What ReadmeBot detects in your project
ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:
tsconfig.jsonpackage.json.eslintrcjest.config.ts
What's included in your documentation
Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:
Installation and setup
Build instructions (tsc)
Usage with typed examples
Type definitions and exports
Testing instructions
Frequently asked questions
Does it document exported types?
Yes. ReadmeBot analyses your TypeScript exports and documents key interfaces, types, and generics that consumers need to know about.
Will it detect strict mode settings?
ReadmeBot reads tsconfig.json and notes relevant compiler options in the development setup section when they affect contributors.
Can it generate docs for declaration-only packages?
Yes. Whether your project ships .d.ts files, uses declaration maps, or is a pure type package, ReadmeBot adapts the README accordingly.