node package manager
Loosely couple your services. Use Orgs to version and reuse your code. Create a free org »

@compodoc/compodoc

Compodoc: The missing documentation tool for your Angular application
Linux Build Status Windows Build Status Codecov npm badge npm dependencies npm devDependencies MIT badge

saucelabs badge

Gitter badge

The missing documentation tool for your Angular application.

Compodoc: The missing documentation tool for your Angular application

Live Demo

A live demo is available — see it in action!

The demo features documentation generated for a simple TodoMVC application.

Features

  • Clean, simple design — Navigate the documentation on the left side, read it on the right.

  • Beautiful themes — Seven themes are available from well known documentation tools like Gitbook, Read the Docs and projects like Vagrant, Laravel, Postmark and Stripe.

  • Search — Includes a powerful search engine (lunr.js) for easily finding what you're looking for.

  • Automatic table of contents — API table of contents is generated using elements found during files parsing.

  • JSDoc light support — Support for @param, @returns, @link and @example tags.

  • Documentation coverage — Get the documentation coverage report of your project.

  • Angular CLI-friendly — Supports Angular CLI projects out-of-the-box.

  • Offline — No server needed, no sources uploaded online, documentation generated entirely offline.

  • Open-source and on npm — Use it directly in your project using npm and a single script—that's it!

Documentation

Official documentation has moved to https://compodoc.github.io/website/.

Installation

Ready to get started? Read installation instructions.

Contributing

Want to file a bug, contribute some code, or improve documentation? Excellent!

Read up on our guidelines for contributing.

Contributors

vogloblinsky mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs

License

Everything in this repository is licensed under the MIT License unless otherwise specified.

Copyright (c) 2016–2017 Vincent Ogloblinsky