Menu
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?
470
Angular 2 is a framework for building web or mobile applications in HTML and Javascript or Typescript. It's the right choice of framework to use for your web or mobile applications.
Angular 2 is an open source JavaScript framework to build web applications in HTML and JavaScript. This tutorial looks at the various aspects of Angular 2 framework which includes the basics of the framework, the setup of Angular and how to work with the various aspects of the framework.
Though AngularJS and Angular 2 are both frameworks for developing websites, they use different coding languages. AngularJS uses JavaScript, a text-based coding language used to make interactive elements. Angular 2 uses TypeScript, a subset of JavaScript created by Microsoft that incorporates static type definitions.
TypeScript is a primary language for Angular application development. It is a superset of JavaScript with design-time support for type safety and tooling. Browsers can't execute TypeScript directly. Typescript must be "transpiled" into JavaScript using the tsc compiler, which requires some configuration.
The only thing I have found so far is TypeDoc. It is not specific to angular but it will create some documentation for you based off of the typescript. It does appear to lack the ability to do certain things you may be used to with ngDoc (live examples and such).
79
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.
21
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
