1 repository
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 este un generator de documentație API TypeScript, generator de site-uri statice și vizualizator de arhitectură de proiect. Acesta analizează codul sursă și comentariile JSDoc pentru a crea site-uri de referință tehnică căutabile, cataloage API și pagini HTML independente. Proiectul se distinge prin analizarea instrucțiunilor de import pentru a produce grafuri de dependență și hărți de module care ilustrează relațiile structurale dintr-un codebase. Include suport specializat pentru vizualizarea proiectelor Angular, fluxurilor de lucru NestJS și componentelor web Stencil, și poate încorpora demo-uri live direct în paginile de documentație. Sistemul funcționează, de asemenea, ca un analizor de acoperire a documentației, oferind rapoarte și impunând praguri minime de acoperire în cadrul pipeline-urilor de integrare continuă pentru a eșua build-urile dacă nivelurile de documentație sunt insuficiente. Capabilitățile suplimentare includ integrarea Markdown, exportul de date în formate multiple (JSON sau Markdown) și un server de dezvoltare local cu monitorizarea sistemului de fișiere pentru reconstrucții automate. Utilizatorii pot personaliza output-ul prin fișiere de configurare, stilizare CSS personalizată și filtrarea vizibilității elementelor pentru a exclude simboluri specifice sau tag-uri interne din site-ul final.
Produces architectural diagrams and API catalogues specifically for NestJS applications.