The missing documentation tool for your Angular application
A live demo is available HERE.
It is the documentation generated for this demo project which is a simple TodoMVC application.
Clean, simple design — With Compodoc, the main endpoints are on the left side of your documentation, and all the content on the right side
Search — Compodoc include a powerful search engine (lunr.js) for easily finding your information
Automatic table of contents - API table of contents is generated using elements found during files parsing
Open-source and on npm - Use it directly in your project using npm and one script, that's it !
A local tool - No server needed, no sources uploaded online
JSDoc light support - Support of @param, @returns, @link and @example tags
Documentation coverage - Get the documentation coverage report of your project
Angular-CLI friendly - Compodoc support out of the box Angular-CLI projects
Official documentation has moved to https://compodoc.github.io/website/
Want to file a bug, contribute some code, or improve documentation? Excellent !
Read up on our guidelines for contributing.
Everything in this repo is MIT License unless otherwise specified.
MIT © 2016-2017 - Vincent Ogloblinsky