TypeStrong/typedoc
Typedoc
TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface.
The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes.
Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It supports monorepo workspaces, multi-format exports, and the integration of markdown content. The toolset also provides symbol filtering, member visibility controls, and a watch-mode for automated documentation updates as source files change.
Features
- API Reference Generators - Analyzes TypeScript source code to produce structured API reference websites for functions, classes, and interfaces.
- TypeScript Definition Renderers - Generates structured technical reference pages from TypeScript definitions and TSDoc annotations.
- Documentation Coverage Analysis - Validates that all exported symbols have descriptions and treats missing documentation as build errors.
- API Reference Publishing - Creates public-facing API reference sites for shared libraries to facilitate external integration.
- Extensible Frameworks - Provides a modular framework that supports custom plugins and themes to extend the documentation generation process.
- Static Site and Document Generators - Functions as a build-time engine that transforms TypeScript source files into a rendered static web interface.
- Documentation Generators - Generates technical documentation in web or data formats with customizable themes and search settings.
- Documentation Generators - Analyzes TypeScript source code and comments to produce structured API reference websites or data files.
- Compiler API Integrations - Integrates with the official TypeScript Compiler API to analyze source code and extract types from the abstract syntax tree.
- AST Analyzers - Parses TypeScript source files and compiler settings into a structured project model for analysis.
- Intermediate Representations - Maps source code into a structured intermediate representation of symbols and documents before final rendering.
- Entry-Point Symbol Resolution - Implements symbol resolution by traversing exported members from defined entry points to map the public API surface.
- Export Analysis Tools - Analyzes exported code and follows re-exports from entry points to accurately document the public interface.
- Public API Export Mappings - Analyzes exported members and re-exports from entry points to ensure the full public API is captured in the documentation.
- Documentation Transformations - Transforms source code into searchable documentation by analyzing entry points and compiler settings.
- Source File Parsing - Converts TypeScript source files into a structured abstract syntax tree for documentation analysis.
- Multi-Format Exports - Provides capabilities for exporting documentation into various distinct file formats such as HTML and JSON.
- Document Content Structuring - Controls the grouping, categorization, and sorting of symbols and entry points in the final documentation output.
- Static Site Templating - Converts the internal project model into static HTML or JSON files using customizable themes and layout engines.
- Member Visibility Filtering - Filters which code elements appear in the documentation based on visibility settings and protection levels.
- Plugin Package Loading - Allows importing community packages to add new features and behaviors to the documentation generation process.
- Monorepo Documentation Sets - Builds separate documentation sets for multiple packages and merges them into a single unified site.
- Symbol Filtering - Implements mechanisms to include or exclude specific source code symbols based on visibility or custom patterns.
- Documentation Automation - Provides integrations that trigger documentation updates automatically based on changes in the source code.
- Parsing Configurations - Defines how docstrings are interpreted using custom tags, link resolution, and standard documentation formats.
- Documentation Validators - Validates that exported TypeScript members have descriptions, treating missing documentation as build errors.
- Hook-Based Extension Frameworks - Provides a programmable plugin system allowing external packages to inject logic into the documentation pipeline via hooks.
- Documentation Logic Extenders - Extends the generator's core logic through a programmable interface to add specialized documentation capabilities.
- Visual Style Customization - Allows customizing the appearance of the generated documentation using themes and stylesheets.
- Developer Utilities - Documentation generator for source code.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
