The missing documentation tool for your Angular application.
# Live Demo
A live demo is available — **[see it in action][demo]** !
The demo features documentation generated for a simple [TodoMVC application].
[demo]: https://compodoc.github.io/compodoc-demo-todomvc-angular/
[TodoMVC application]: https://github.com/compodoc/compodoc-demo-todomvc-angular
# 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!
[Gitbook]: https://www.gitbook.com
[Read the Docs]: https://readthedocs.org/
[Vagrant]: https://www.vagrantup.com/docs/
[Laravel]: https://laravel.com/docs/5.3
[Postmark]: http://developer.postmarkapp.com/
[Stripe]: https://stripe.com/docs/api
[lunr.js]: http://lunrjs.com/
[Angular CLI]: https://cli.angular.io/
[npm]: https://www.npmjs.com/
# Documentation
Official documentation has moved to [https://compodoc.github.io/website/](https://compodoc.github.io/website/guides/getting-started.html).
# Installation
Ready to get started? [Read installation instructions](https://compodoc.github.io/website/guides/installation.html).
# Contributing
Want to file a bug, contribute some code, or improve documentation? Excellent!
Read up on our guidelines for [contributing](https://github.com/compodoc/compodoc/blob/master/CONTRIBUTING.md).
# Contributors
|[
](https://github.com/vogloblinsky)|[
](https://github.com/mattlewis92)|[
](https://github.com/JonasMH)|[
](https://github.com/rprotsyk)|[
](https://github.com/daniele-zurico)|[
](https://github.com/profimedica)|[
](https://github.com/guilhermevrs)|[
](https://github.com/dp-1a)|
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
|[vogloblinsky](https://github.com/vogloblinsky)|[mattlewis92](https://github.com/mattlewis92)|[JonasMH](https://github.com/JonasMH)|[rprotsyk](https://github.com/rprotsyk)|[daniele-zurico](https://github.com/daniele-zurico)|[profimedica](https://github.com/profimedica)|[guilhermevrs](https://github.com/guilhermevrs)|[dp-1a](https://github.com/dp-1a)|
# License
Everything in this repository is [licensed under the MIT License][license] unless otherwise specified.
Copyright (c) 2016–2017 [Vincent Ogloblinsky]
[license]: https://github.com/compodoc/compodoc/blob/master/LICENSE
[Vincent Ogloblinsky]: http://www.vincentogloblinsky.com