DEV Community

John Peters
John Peters

Posted on • Edited on

Angular Documentation (Fast)

Do you want an API for your project?

  // don't tarry, just install this.
  npm install -g @compodoc/compodoc
  compodoc -p src/tsconfig.app.json -s
Enter fullscreen mode Exit fullscreen mode

Take a look at this:

Alt Text

I was astounded at how quickly our entire project was documented in an API format.

Compodoc is for Angular. It takes 2 minutues to install and 2 minutes to serve up the example shown above.

Here's a live example

Alt Text

JWP 2020

Top comments (0)