The missing documentation tool for your Angular application.
A live demo is available — see it in action!
The demo features documentation generated for a simple TodoMVC application.
Clean, simple design — Navigate the documentation on the left side, read it on the right.
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
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!
Official documentation has moved to https://compodoc.github.io/website/.
Ready to get started? Read installation instructions.
Want to file a bug, contribute some code, or improve documentation? Excellent!
Read up on our guidelines for contributing.
Everything in this repository is licensed under the MIT License unless otherwise specified.
Copyright (c) 2016–2017 Vincent Ogloblinsky