compodoc/compodoc
Compodoc
Compodoc est un générateur de documentation API TypeScript, un générateur de site statique et un visualiseur d'architecture de projet. Il analyse le code source et les commentaires JSDoc pour créer des sites de référence technique consultables, des catalogues API et des pages HTML autonomes.
Le projet se distingue par l'analyse des instructions d'importation pour produire des graphes de dépendances et des cartes de modules illustrant les relations structurelles au sein d'une base de code. Il inclut un support spécialisé pour la visualisation de projets Angular, de flux de travail NestJS et de composants web Stencil, et peut intégrer des démos fonctionnelles directement dans les pages de documentation.
Le système fonctionne également comme un analyseur de couverture de documentation, fournissant des rapports et imposant des seuils de couverture minimaux au sein des pipelines d'intégration continue pour faire échouer les builds si les niveaux de documentation sont insuffisants. Les capacités supplémentaires incluent l'intégration Markdown, l'exportation de données multi-format vers JSON ou Markdown, et un serveur de développement local avec surveillance du système de fichiers pour des reconstructions automatiques.
Les utilisateurs peuvent personnaliser la sortie via des fichiers de configuration, des styles CSS personnalisés et le filtrage de visibilité des éléments pour exclure des symboles spécifiques ou des balises internes du site final.
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.
- Outils de développement - 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.
