1 repositorio
Creating architectural maps and API catalogues for NestJS applications.
Distinct from NestJS Integrations: Shortlist candidates focus on general NestJS integrations or testing, not documentation workflows.
Explore 1 awesome GitHub repository matching web development · NestJS API Documentation. Refine with filters or upvote what's useful.
Compodoc es un generador de documentación de API para TypeScript, generador de sitios estáticos y visualizador de arquitectura de proyectos. Analiza el código fuente y los comentarios JSDoc para crear sitios de referencia técnica, catálogos de API y páginas HTML independientes que se pueden buscar. El proyecto se distingue por analizar las sentencias de importación para producir grafos de dependencia y mapas de módulos que ilustran las relaciones estructurales dentro de una base de código. Incluye soporte especializado para visualizar proyectos Angular, flujos de trabajo NestJS y componentes web Stencil, y puede incrustar demos funcionales en vivo directamente en las páginas de documentación. El sistema también funciona como un analizador de cobertura de documentación, proporcionando informes y aplicando umbrales mínimos de cobertura dentro de pipelines de integración continua para fallar builds si los niveles de documentación son insuficientes. Las capacidades adicionales incluyen integración con markdown, exportación de datos en múltiples formatos a JSON o Markdown, y un servidor de desarrollo local con monitoreo del sistema de archivos para reconstrucciones automáticas. Los usuarios pueden personalizar la salida a través de archivos de configuración, estilos CSS personalizados y filtrado de visibilidad de elementos para excluir símbolos específicos o etiquetas internas del sitio final.
Produces architectural diagrams and API catalogues specifically for NestJS applications.