TypeDocs
TypeDocs is a library that helps generate API documentation for TypeScript code.
Installing
npm install typedocs
Usage
To get documentation programmatically, you can invoke this library programmatically as follows: -
; "use strict"; ; // Generate documentation by calling the generate function// passing in the definition files.; // Optionally you can flatten the modules to include// separate items for nested modules.;
To generate a docs website, execute the following: -
; "use strict"; ; // Generate documentation by calling the generate function// passing in the definition files.;
Sample
The samples folder contains an app that demonstrates the usage above. You can run the below command to exercise it.
node sampleapp.js
Contributing
To contribute to the project please go through the Contributing.md guide.