To get started, create a docsConfig.json file in your project root directory with the following content :
{ "outputDir": "path/to/output", "contentDir": "path/to/guidesandcontents", "apiDir": "path/to/projectcode", "logoFile": "img/logo.png" }
- Make sure you have Node.js installed.
- Run
npm install ngdocs -gto create the ngdocs package. - Run ngdocs from your project root folder.
See https://github.com/idanush/ngdocs/wiki/API-Docs-Syntax for documenting your code.