Documentation generator & viewer for Angular 2 projects http://angulardoc.cfapps.io/

Team Members

Launch Site

AngularDoc

Documenting Angular 2 projects does not have to be painful. AngularDoc is a documentation generator & viewer for Angular 2 projects. Just provide the URL of your GitHub project and watch the magic happen.

V800 angulardoc overview

Description

Documenting Angular 2 projects does not have to be painful. Just provide the URL of your GitHub project and watch the magic happen.

Features

  • Browser for classes, components, injectables, routes, directives, and pipes;
  • Visualization of class imports
  • Quick searches

Instructions

Two of the public Angular 2 projects on GitHub were listed on the landing page, allowing everyone to see a quick demo of the AngularDoc features. A third panel lets you enter the link to an Angular 2 project of your choosing, as long as it's a public repo on GitHub.

Once you are in an Angular 2 project, you will see an overview of the project, displaying the counts of the classes, components, injectables, routes, directives, and pipes that AngularDoc has identified. Using the navigation menu on the left panel, you'll see the detailed information on each of these categories. A quick search box on the top right allows you to filter the entries.

View the screencast:
https://www.youtube.com/watch?v=cEeFhF4FWTo

Built With

We used the following open source projects to get us going:

Feedback / Ratings (13)

All Feedback