{"id":13475938,"url":"https://github.com/compodoc/compodoc","last_synced_at":"2025-05-12T05:16:33.569Z","repository":{"id":37405839,"uuid":"71109869","full_name":"compodoc/compodoc","owner":"compodoc","description":":notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest \u0026 Stencil application","archived":false,"fork":false,"pushed_at":"2025-05-08T19:47:59.000Z","size":49072,"stargazers_count":4051,"open_issues_count":124,"forks_count":414,"subscribers_count":73,"default_branch":"develop","last_synced_at":"2025-05-11T21:07:18.418Z","etag":null,"topics":["angular","angular2","ast","devtools","documentation","documentation-tool","generator","jsdoc","typescript"],"latest_commit_sha":null,"homepage":"https://compodoc.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compodoc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["vogloblinsky"],"open_collective":"compodoc"}},"created_at":"2016-10-17T07:09:28.000Z","updated_at":"2025-05-11T20:34:53.000Z","dependencies_parsed_at":"2023-09-25T19:32:43.018Z","dependency_job_id":"82063364-ce0f-4eef-9195-654f46bc589b","html_url":"https://github.com/compodoc/compodoc","commit_stats":{"total_commits":2407,"total_committers":90,"mean_commits":"26.744444444444444","dds":0.1275446614042376,"last_synced_commit":"3fb85c4f179ec385a46d45e5118a900d6d1d0d9e"},"previous_names":[],"tags_count":91,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fcompodoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fcompodoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fcompodoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fcompodoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compodoc","download_url":"https://codeload.github.com/compodoc/compodoc/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253633123,"owners_count":21939389,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular2","ast","devtools","documentation","documentation-tool","generator","jsdoc","typescript"],"created_at":"2024-07-31T16:01:24.904Z","updated_at":"2025-05-12T05:16:33.540Z","avatar_url":"https://github.com/compodoc.png","language":"TypeScript","funding_links":["https://github.com/sponsors/vogloblinsky","https://opencollective.com/compodoc"],"categories":["TypeScript","Uncategorized","Docs","angular","Awesome Angular [![Awesome TipeIO](https://img.shields.io/badge/Awesome%20Angular-@TipeIO-6C6AE7.svg)](https://github.com/gdi2290/awesome-angular) [![Awesome devarchy.com](https://img.shields.io/badge/Awesome%20Angular-@devarchy.com-86BDC1.svg)](https://github.com/brillout/awesome-angular-components)","Development Utilities"],"sub_categories":["Uncategorized","Angular \u003ca id=\"angular\"\u003e\u003c/a\u003e","Documentation Tools"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://avatars3.githubusercontent.com/u/23202313\" alt=\"Compodoc: The missing documentation tool for your Angular application\" width=\"226\"\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"https://github.com/compodoc/compodoc/actions\"\u003e\u003cimg src=\"https://github.com/compodoc/compodoc/workflows/CI/badge.svg\" alt=\"Github action Build Status\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/compodoc/compodoc\"\u003e\u003cimg src=\"https://codecov.io/gh/compodoc/compodoc/branch/develop/graph/badge.svg\" alt=\"Codecov\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/@compodoc/compodoc\"\u003e\u003cimg src=\"https://badge.fury.io/js/%40compodoc%2Fcompodoc.svg\" alt=\"npm badge\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://sonarcloud.io/dashboard?id=compodoc_compodoc\"\u003e\u003cimg src=\"https://sonarcloud.io/api/project_badges/measure?project=compodoc_compodoc\u0026metric=alert_status\" alt=\"Quality Gate Status\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://snyk.io/test/github/compodoc/compodoc\"\u003e\u003cimg src=\"https://snyk.io/test/github/compodoc/compodoc/badge.svg\" alt=\"Known Vulnerabilities\"/\u003e\u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"https://npmcharts.com/compare/@compodoc/compodoc?minimal=true\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/@compodoc/compodoc.svg?style=flat\" alt=\"NPM Downloads\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"http://img.shields.io/badge/license-MIT-brightgreen.svg\" alt=\"MIT badge\"/\u003e\u003c/a\u003e\n  \u003cbr/\u003e\n  \u003ca href=\"#backers\"\u003e\u003cimg src=\"https://opencollective.com/compodoc/backers/badge.svg\" alt=\"sponsors on Open Collective\" /\u003e\u003c/a\u003e \u003ca href=\"#sponsors\"\u003e\u003cimg src=\"https://opencollective.com/compodoc/sponsors/badge.svg\" alt=\"Sponsors on Open Collective\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://saucelabs.com/browser-matrix/compodoc.svg\" alt=\"saucelabs badge\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://gitter.im/compodoc/compodoc\" target=\"_blank\"\u003e\u003cimg src=\"https://badges.gitter.im/Join%20Chat.svg\" alt=\"Gitter badge\"/\u003e\u003c/a\u003e\u003cbr\u003e\u003cbr\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eThe missing documentation tool for your Angular application.\u003cbr\u003e\u003cbr\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/compodoc/compodoc/master/screenshots/main-view.gif\" alt=\"Compodoc: The missing documentation tool for your Angular application\"/\u003e\n\u003c/p\u003e\n\n# Live Demo\n\nA live demo is available — **[see it in action][demo]** !\n\nThe demo features documentation generated for a simple [TodoMVC application].\n\n[demo]: https://compodoc.github.io/compodoc-demo-todomvc-angular/\n[todomvc application]: https://github.com/compodoc/compodoc-demo-todomvc-angular\n\n# Features\n\n-   **Clean, simple design** — Navigate the documentation on the left side, read it on the right.\n\n-   **Beautiful themes** — Seven themes are available from well known documentation tools like [Gitbook], [Read the Docs] and projects like [Vagrant], [Laravel], [Postmark] and [Stripe].\n\n-   **Search** — Includes a powerful search engine ([lunr.js]) for easily finding what you're looking for.\n\n-   **Automatic table of contents** — API table of contents is generated using elements found during files parsing.\n\n-   **JSDoc light support** — Support for `@param`, `@returns`, `@link`, `@ignore` and `@example` tags.\n\n-   **Documentation coverage** — Get the documentation coverage report of your project.\n\n-   **Angular CLI-friendly** — Supports [Angular CLI] projects out-of-the-box.\n\n-   **Offline** — No server needed, no sources uploaded online, documentation generated entirely offline.\n\n-   **Open-source and on npm** — Use it directly in your project using [npm] and a single script—that's it!\n\n[gitbook]: https://www.gitbook.com\n[read the docs]: https://readthedocs.org/\n[vagrant]: https://www.vagrantup.com/docs/\n[laravel]: https://laravel.com/docs/5.3\n[postmark]: https://developer.postmarkapp.com/\n[stripe]: https://stripe.com/docs/api\n[lunr.js]: https://lunrjs.com/\n[angular cli]: https://cli.angular.io/\n[npm]: https://www.npmjs.com/\n\n# Documentation\n\nOfficial documentation has moved to [https://compodoc.github.io/website/](https://compodoc.github.io/website/guides/getting-started.html).\n\n# Installation\n\nReady to get started? [Read installation instructions](https://compodoc.github.io/website/guides/installation.html).\n\n# 🏅 Backers\n\nThank you to all our backers ! Support us with a monthly donation and help us continue our activities. [Become a backer][support-url]\n\n[![Backers][backers-image]][support-url]\n\n# 🎖 Sponsors\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor][support-url]\n\n[![Sponsors][sponsors-image]][support-url]\n\n# Contributing\n\nWant to file a bug, contribute some code, or improve documentation? Excellent!\n\nRead up on our guidelines for [contributing](https://github.com/compodoc/compodoc/blob/master/CONTRIBUTING.md).\n\n# Contributors\n\nThis project exists thanks to all these people.\n\n| [\u003cimg alt=\"vogloblinsky\" src=\"https://avatars3.githubusercontent.com/u/2841805?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/vogloblinsky) | [\u003cimg alt=\"manekinekko\" src=\"https://avatars3.githubusercontent.com/u/1699357?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/manekinekko) | [\u003cimg alt=\"mattlewis92\" src=\"https://avatars1.githubusercontent.com/u/6425649?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/mattlewis92) | [\u003cimg alt=\"JonasMH\" src=\"https://avatars0.githubusercontent.com/u/1939229?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/JonasMH) | [\u003cimg alt=\"rprotsyk\" src=\"https://avatars0.githubusercontent.com/u/104502?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/rprotsyk) | [\u003cimg alt=\"daniele-zurico\" src=\"https://avatars0.githubusercontent.com/u/3193095?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/daniele-zurico) | [\u003cimg alt=\"profimedica\" src=\"https://avatars0.githubusercontent.com/u/2903499?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/profimedica) |\n| :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |\n|                                              [vogloblinsky](https://github.com/vogloblinsky)                                              |                                              [manekinekko](https://github.com/manekinekko)                                              |                                              [mattlewis92](https://github.com/mattlewis92)                                              |                                              [JonasMH](https://github.com/JonasMH)                                              |                                             [rprotsyk](https://github.com/rprotsyk)                                              |                                              [daniele-zurico](https://github.com/daniele-zurico)                                              |                                              [profimedica](https://github.com/profimedica)                                              |\n\n| [\u003cimg alt=\"vogloblinsky\" src=\"https://avatars3.githubusercontent.com/u/32763448?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/dp-1a) | [\u003cimg alt=\"guilhermevrs\" src=\"https://avatars0.githubusercontent.com/u/14924373?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/ValentinGot) | [\u003cimg alt=\"Blakesalot\" src=\"https://avatars1.githubusercontent.com/u/10159693?s=460\u0026v=4\" width=\"117\"/\u003e](https://github.com/Blakesalot) | [\u003cimg alt=\"Brigitte Hofmeister\" src=\"https://avatars1.githubusercontent.com/u/16089658?s=460\u0026v=4\" width=\"117\"/\u003e](https://github.com/bhofmei) | [\u003cimg alt=\"lichangfeng\" src=\"https://avatars2.githubusercontent.com/u/8101989?s=460\u0026v=4\" width=\"117\"/\u003e](https://github.com/lichangfeng) | [\u003cimg alt=\"guilhermevrs\" src=\"https://avatars0.githubusercontent.com/u/1570567?v=4\u0026s=117\" width=\"117\"/\u003e](https://github.com/guilhermevrs) |\n| :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------- |\n|                                                  [dp-1a](https://github.com/dp-1a)                                                  |                                               [ValentinGot](https://github.com/ValentinGot)                                               |                                             [Blake Simmon](https://github.com/Blakesalot)                                              |                                              [Brigitte Hofmeister](https://github.com/bhofmei)                                               |                                              [lichangfeng](https://github.com/lichangfeng)                                              | [guilhermevrs](https://github.com/guilhermevrs)                                                                                           |\n\n# Big Thanks\n\nCross-browser Testing Platform and Open Source \u003c3 Provided by [Sauce Labs][homepage]\n\n[homepage]: https://saucelabs.com\n\n# License\n\nEverything in this repository is [licensed under the MIT License][license] unless otherwise specified.\n\nCopyright (c) 2016 – 2019 [Vincent Ogloblinsky]\n\n[license]: https://github.com/compodoc/compodoc/blob/master/LICENSE\n[vincent ogloblinsky]: https://www.vincentogloblinsky.com\n[support-url]: https://opencollective.com/compodoc#support\n[backers-image]: https://opencollective.com/compodoc/backers.svg\n[sponsors-image]: https://opencollective.com/compodoc/sponsor.svg\n[github-action-badge]: https://github.com/compodoc/compodoc/workflows/CI/badge.svg\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompodoc%2Fcompodoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompodoc%2Fcompodoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompodoc%2Fcompodoc/lists"}