Package Exports
- @compodoc/compodoc
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@compodoc/compodoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
The missing documentation tool for your Angular application
Live Demo
A live demo is available HERE.
It is the documentation generated for this demo project which is a simple TodoMVC application.
Features
Clean, simple design — With Compodoc, the main endpoints are on the left side of your documentation, and all the content on the right side
Beautiful themes — 7 themes are available from famous documentation tools like Gitbook, Read the Docs or projects like Vagrant, Laravel, Postmark and Stripe.
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
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
A local tool - No server needed, no sources uploaded online
Open-source and on npm - Use it directly in your project using npm and one script, that's it !
Documentation
Official documentation has moved to https://compodoc.github.io/website/
Contributing
Want to file a bug, contribute some code, or improve documentation? Excellent !
Read up on our guidelines for contributing.
Contributors
 |
 |
 |
 |
|---|---|---|---|
| vogloblinsky | daniele-zurico | mattlewis92 | rprotsyk |
License
Everything in this repo is MIT License unless otherwise specified.
MIT © 2016-2017 - Vincent Ogloblinsky