Writing content
API Documentation
Customization
Recipes
API References Develop
Getting Started Installation

Installation

NgDoc doesn't serve as a standalone application, but rather as a tool that can be integrated into your application to generate documentation. This means that you will need to create a new Angular application, or use an existing one, and install NgDoc as a dependency.

Automatic (recommended) Manual

To install the NgDoc, you can use the command below. This command will automatically install and add the library to your project, and configure it.

TypeScript may display an error for the @ng-doc/generated path in your code editor if you are using the library for the first time. Files for the @ng-doc/generated path will be generated automatically when you run your application, so please disregard any errors related to it.

Angular
Nx Nx
ng add @ng-doc/add

By default, NgDoc uses your project's sourceRoot as the directory where you should create documentation, you can always change this, see the Configuration article for more details