Compodoc

Compodoc is a documentation tool for Angular applications, and it also supports Nest and Stencil projects. It scans your source code and creates a documentation site for it in seconds.

Compodoc reads the project and builds pages that describe its parts, such as modules, components and services. The output includes an overview page for the whole project, so a new developer can see how the code is organized without reading every file. It runs from the command line and writes static files you can publish.

• Builds a documentation site from your source code
• Overview page for the whole project
• Supports Angular, Nest and Stencil
• Runs as a command-line tool
• Changelog and getting started guide on its site

Angular developers who want reference documentation for a codebase without writing it by hand. Teams using Nest or Stencil can use it in the same way, and it suits projects that change often and need the docs to stay in step.

The repository is listed under the MIT license, so the tool is free to use under those terms. It runs locally on a machine with Node.js, and the output is static files that can be published on any web server. The documentation reflects what the code declares, so good comments and typed inputs make the result more useful.