@compodoc/compodoc
Advanced tools
@compodoc/compodoc is a documentation tool for Angular applications. It generates static documentation of your Angular application, including components, modules, services, and more. It provides a comprehensive view of your application structure and helps in maintaining and understanding the codebase.
Generate Documentation
This command generates documentation for your Angular project based on the TypeScript configuration file. It scans the project files and creates a static documentation site.
npx @compodoc/compodoc -p tsconfig.jsonServe Documentation
This command serves the generated documentation on a local server, allowing you to view it in your browser. It is useful for quickly accessing and navigating the documentation.
npx @compodoc/compodoc -sWatch Mode
This command runs Compodoc in watch mode, automatically regenerating the documentation whenever there are changes in the source files. It is useful for continuous documentation updates during development.
npx @compodoc/compodoc -p tsconfig.json -wCustomizing Documentation
This command generates documentation with a custom theme. Compodoc supports various themes, allowing you to customize the look and feel of the generated documentation.
npx @compodoc/compodoc -p tsconfig.json --theme vagrantTypeDoc is a documentation generator for TypeScript projects. It generates documentation directly from the TypeScript source code, similar to how JSDoc works for JavaScript. Compared to @compodoc/compodoc, TypeDoc is more general-purpose and can be used with any TypeScript project, not just Angular.
JSDoc is a popular documentation generator for JavaScript projects. It can be used with TypeScript as well, but it requires additional configuration. Compared to @compodoc/compodoc, JSDoc is more flexible and can be used with a wider range of JavaScript and TypeScript projects, but it does not provide Angular-specific features.
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.
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!
Official documentation has moved to https://compodoc.github.io/website/.
Ready to get started? Read installation instructions.
Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. Become a backer
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor
Want to file a bug, contribute some code, or improve documentation? Excellent!
Read up on our guidelines for contributing.
This project exists thanks to all these people.
 |  |  |  |  |  |  |
|---|---|---|---|---|---|---|
| vogloblinsky | manekinekko | mattlewis92 | JonasMH | rprotsyk | daniele-zurico | profimedica |
 |  |  |  |  |  |
|---|---|---|---|---|---|
| dp-1a | ValentinGot | Blake Simmon | Brigitte Hofmeister | lichangfeng | guilhermevrs |
Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs
Everything in this repository is licensed under the MIT License unless otherwise specified.
Copyright (c) 2016 – 2019 Vincent Ogloblinsky
FAQs
The missing documentation tool for your Angular application
The npm package @compodoc/compodoc receives a total of 311,595 weekly downloads. As such, @compodoc/compodoc popularity was classified as popular.
We found that @compodoc/compodoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.