πŸ“” The missing documentation tool for your Angular application
Latest commit cc9c887 Sep 6, 2018

README.md

Compodoc: The missing documentation tool for your Angular application
Linux Build Status Windows Build Status Codecov npm badge npm dependencies npm devDependencies NPM Downloads 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, @ignore 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.

πŸ… Backers

Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. Become a backer

Backers

πŸŽ– Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

Sponsors

Contributing

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

Read up on our guidelines for contributing.

Contributors

This project exists thanks to all these people.

vogloblinsky manekinekko mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky manekinekko mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky guilhermevrs Blakesalot Brigitte Hofmeister lichangfeng
dp-1a ValentinGot Blake Simmon Brigitte Hofmeister lichangfeng

License

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

Copyright (c) 2016 – 2018 Vincent Ogloblinsky