Reputation: 261
I have a bit of experience with angular 2, but I'm still relatively new to the Framework. While looking around, I discovered something called ngdocs. It's very nice because it creates a sort of documentation / wiki area for you based on the comments in your code. (similar to js docs). However, it seems to be written exclusively for use with angular 1.XX.
I've done some searching around, but can't seem to find anything that would provide similar functionality for angular 2. Does anyone know if there is something similar to ng-docs for angular 2?
Upvotes: 9
Views: 2459
Reputation: 5455
There is also a project called Compodoc (https://medium.com/vincent-ogloblinsky/compodoc-documentation-tool-for-angular-2-applications-44ec650e01a8), which generates documentation specific for Angular 2/4.
They are using normal comments and have added support of markdown syntax as well.
Upvotes: 3