compodoc/compodoc
Compodoc
Compodoc 是一个 TypeScript API 文档生成器、静态站点生成器和项目架构可视化工具。它解析源代码和 JSDoc 注释，以创建可搜索的技术参考站点、API 目录和独立 HTML 页面。
该项目通过分析 import 语句来生成依赖图和模块映射，从而展示代码库内的结构关系，这使其脱颖而出。它包括对可视化 Angular 项目、NestJS 工作流和 Stencil Web 组件的专门支持，并可将实时工作演示直接嵌入到文档页面中。
该系统还充当文档覆盖率分析器，提供报告并在持续集成流水线中强制执行最低覆盖率阈值，如果文档水平不足则导致构建失败。其他功能包括 Markdown 集成、多格式数据导出（JSON 或 Markdown），以及带有文件系统监控以实现自动重建的本地开发服务器。
用户可以通过配置文件、自定义 CSS 样式和元素可见性过滤来自定义输出，以从最终站点中排除特定符号或内部标签。
Features
- TypeScript - Parses TypeScript source files and JSDoc to generate searchable technical reference sites.
- Documentation Coverage Analysis - Calculates the percentage of documented code and provides reports on documentation gaps.
- Coverage Threshold Enforcement - Automatically fails the build process when documentation coverage falls below a defined percentage threshold.
- API Reference Generators - Transforms source code and JSDoc into searchable technical reference manuals for components and classes.
- Static Site Generators - Compiles project metadata and templates into a standalone set of static HTML files.
- Structural Dependency Mapping - Analyzes import and export statements to create visual maps of structural relationships and module dependencies.
- API Documentation Generators - Parses source code and comments to produce structured API reference materials and catalogues for TypeScript projects.
- Angular Project Visualizations - Creates dependency graphs and architectural maps to visualize the structural relationships within Angular applications.
- JSDoc Annotation Generators - Parses JSDoc annotations from TypeScript and JavaScript source files to generate API documentation.
- Dependency Graph Visualizations - Maps structural relationships and dependencies between application modules and files via dependency graphs.
- Architecture Visualizers - Uses static analysis to generate visual maps of codebase structure and component dependencies.
- AST Extraction - Extracts abstract syntax trees from source code to identify components and classes for documentation purposes.
- NestJS API Documentation - Produces architectural diagrams and API catalogues specifically for NestJS applications.
- Entity-Linked Markdown - Pairs markdown files with source code entities to provide detailed descriptions beyond standard comments.
- Markdown to HTML Converters - Transforms markdown files and inline documentation into formatted HTML pages with syntax highlighting.
- Multi-Format Document Exports - Outputs documentation in multiple formats, including static HTML, JSON, and Markdown.
- UI Component API Documentation - Generates technical documentation and interactive API references specifically for Stencil web components.
- API Documentation Search - Includes a built-in search engine to quickly locate specific APIs and codebase elements.
- External File Importers - Imports external markdown directories and files to expand the available reference material in the site.
- Interactive Code Demos - Adds interactive tabs to documentation pages to showcase live working examples of the code.
- Documentation Density Metrics - Calculates the ratio of documentation comments to source code statements to identify gaps.
- External Content Inclusions - Embeds external markdown files and assets directly into the generated documentation structure.
- Documentation Coverage Validation - Validates that API symbols are adequately documented against a percentage threshold to ensure documentation completeness.
- Documentation Themes - Provides pre-built visual templates and layouts specifically designed for documentation websites.
- 开发者工具 - Documentation generation tool for Angular applications.
- Development Tooling - Documentation generation tool for application codebases.
- Documentation Generators - Documentation generator for Angular applications.
- Documentation Tools - Documentation generator for application code.
