1 | <p align="center">
|
2 | <img src="https://avatars3.githubusercontent.com/u/23202313" alt="Compodoc: The missing documentation tool for your Angular application" width="226">
|
3 | <br/>
|
4 | <a href="https://github.com/compodoc/compodoc/actions"><img src="https://github.com/compodoc/compodoc/workflows/CI/badge.svg" alt="Github action Build Status"/></a>
|
5 | <a href="https://codecov.io/gh/compodoc/compodoc"><img src="https://codecov.io/gh/compodoc/compodoc/branch/develop/graph/badge.svg" alt="Codecov"/></a>
|
6 | <a href="https://www.npmjs.com/package/@compodoc/compodoc"><img src="https://badge.fury.io/js/%40compodoc%2Fcompodoc.svg" alt="npm badge"/></a>
|
7 | <a href="https://sonarcloud.io/dashboard?id=compodoc_compodoc"><img src="https://sonarcloud.io/api/project_badges/measure?project=compodoc_compodoc&metric=alert_status" alt="Quality Gate Status"/></a>
|
8 | <br/>
|
9 | <a href="https://npmcharts.com/compare/@compodoc/compodoc?minimal=true"><img src="https://img.shields.io/npm/dm/@compodoc/compodoc.svg?style=flat" alt="NPM Downloads"/></a>
|
10 | <a href="https://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"/></a>
|
11 | <br/>
|
12 | <a href="#backers" alt="sponsors on Open Collective"><img src="https://opencollective.com/compodoc/backers/badge.svg" /></a> <a href="#sponsors" alt="Sponsors on Open Collective"><img src="https://opencollective.com/compodoc/sponsors/badge.svg" /></a>
|
13 | </p>
|
14 | <p align="center">
|
15 | <img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge"/>
|
16 | </p>
|
17 | <p align="center">
|
18 | <a href="https://gitter.im/compodoc/compodoc" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"/></a><br><br>
|
19 | </p>
|
20 |
|
21 | <p align="center">The missing documentation tool for your Angular application.<br><br></p>
|
22 |
|
23 | <p align="center">
|
24 | <img src="https://raw.githubusercontent.com/compodoc/compodoc/master/screenshots/main-view.gif" alt="Compodoc: The missing documentation tool for your Angular application"/>
|
25 | </p>
|
26 |
|
27 | # Live Demo
|
28 |
|
29 | A live demo is available — **[see it in action][demo]** !
|
30 |
|
31 | The demo features documentation generated for a simple [TodoMVC application].
|
32 |
|
33 | [demo]: https://compodoc.github.io/compodoc-demo-todomvc-angular/
|
34 | [todomvc application]: https://github.com/compodoc/compodoc-demo-todomvc-angular
|
35 |
|
36 | # Features
|
37 |
|
38 | - **Clean, simple design** — Navigate the documentation on the left side, read it on the right.
|
39 |
|
40 | - **Beautiful themes** — Seven themes are available from well known documentation tools like [Gitbook], [Read the Docs] and projects like [Vagrant], [Laravel], [Postmark] and [Stripe].
|
41 |
|
42 | - **Search** — Includes a powerful search engine ([lunr.js]) for easily finding what you're looking for.
|
43 |
|
44 | - **Automatic table of contents** — API table of contents is generated using elements found during files parsing.
|
45 |
|
46 | - **JSDoc light support** — Support for `@param`, `@returns`, `@link`, `@ignore` and `@example` tags.
|
47 |
|
48 | - **Documentation coverage** — Get the documentation coverage report of your project.
|
49 |
|
50 | - **Angular CLI-friendly** — Supports [Angular CLI] projects out-of-the-box.
|
51 |
|
52 | - **Offline** — No server needed, no sources uploaded online, documentation generated entirely offline.
|
53 |
|
54 | - **Open-source and on npm** — Use it directly in your project using [npm] and a single script—that's it!
|
55 |
|
56 | [gitbook]: https://www.gitbook.com
|
57 | [read the docs]: https://readthedocs.org/
|
58 | [vagrant]: https://www.vagrantup.com/docs/
|
59 | [laravel]: https://laravel.com/docs/5.3
|
60 | [postmark]: https://developer.postmarkapp.com/
|
61 | [stripe]: https://stripe.com/docs/api
|
62 | [lunr.js]: https://lunrjs.com/
|
63 | [angular cli]: https://cli.angular.io/
|
64 | [npm]: https://www.npmjs.com/
|
65 |
|
66 | # Documentation
|
67 |
|
68 | Official documentation has moved to [https://compodoc.github.io/website/](https://compodoc.github.io/website/guides/getting-started.html).
|
69 |
|
70 | # Installation
|
71 |
|
72 | Ready to get started? [Read installation instructions](https://compodoc.github.io/website/guides/installation.html).
|
73 |
|
74 | # 🏅 Backers
|
75 |
|
76 | Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. [Become a backer][support-url]
|
77 |
|
78 | [![Backers][backers-image]][support-url]
|
79 |
|
80 | # 🎖 Sponsors
|
81 |
|
82 | Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor][support-url]
|
83 |
|
84 | [![Sponsors][sponsors-image]][support-url]
|
85 |
|
86 | # Contributing
|
87 |
|
88 | Want to file a bug, contribute some code, or improve documentation? Excellent!
|
89 |
|
90 | Read up on our guidelines for [contributing](https://github.com/compodoc/compodoc/blob/master/CONTRIBUTING.md).
|
91 |
|
92 | # Contributors
|
93 |
|
94 | This project exists thanks to all these people.
|
95 |
|
96 | | [<img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/2841805?v=4&s=117" width="117"/>](https://github.com/vogloblinsky) | [<img alt="manekinekko" src="https://avatars3.githubusercontent.com/u/1699357?v=4&s=117" width="117"/>](https://github.com/manekinekko) | [<img alt="mattlewis92" src="https://avatars1.githubusercontent.com/u/6425649?v=4&s=117" width="117"/>](https://github.com/mattlewis92) | [<img alt="JonasMH" src="https://avatars0.githubusercontent.com/u/1939229?v=4&s=117" width="117"/>](https://github.com/JonasMH) | [<img alt="rprotsyk" src="https://avatars0.githubusercontent.com/u/104502?v=4&s=117" width="117"/>](https://github.com/rprotsyk) | [<img alt="daniele-zurico" src="https://avatars0.githubusercontent.com/u/3193095?v=4&s=117" width="117"/>](https://github.com/daniele-zurico) | [<img alt="profimedica" src="https://avatars0.githubusercontent.com/u/2903499?v=4&s=117" width="117"/>](https://github.com/profimedica) | [<img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/1570567?v=4&s=117" width="117"/>](https://github.com/guilhermevrs) |
|
97 | | :---------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: |
|
98 | | [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) | [guilhermevrs](https://github.com/guilhermevrs) |
|
99 |
|
100 | | [<img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/32763448?v=4&s=117" width="117"/>](https://github.com/dp-1a) | [<img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/14924373?v=4&s=117" width="117"/>](https://github.com/ValentinGot) | [<img alt="Blakesalot" src="https://avatars1.githubusercontent.com/u/10159693?s=460&v=4" width="117"/>](https://github.com/Blakesalot) | [<img alt="Brigitte Hofmeister" src="https://avatars1.githubusercontent.com/u/16089658?s=460&v=4" width="117"/>](https://github.com/bhofmei) | [<img alt="lichangfeng" src="https://avatars2.githubusercontent.com/u/8101989?s=460&v=4" width="117"/>](https://github.com/lichangfeng) |
|
101 | | :---------------------------------------------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------: |
|
102 | | [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) |
|
103 |
|
104 | # Big Thanks
|
105 |
|
106 | Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs][homepage]
|
107 |
|
108 | [homepage]: https://saucelabs.com
|
109 |
|
110 | # License
|
111 |
|
112 | Everything in this repository is [licensed under the MIT License][license] unless otherwise specified.
|
113 |
|
114 | Copyright (c) 2016 – 2019 [Vincent Ogloblinsky]
|
115 |
|
116 | [license]: https://github.com/compodoc/compodoc/blob/master/LICENSE
|
117 | [vincent ogloblinsky]: https://www.vincentogloblinsky.com
|
118 | [support-url]: https://opencollective.com/compodoc#support
|
119 | [backers-image]: https://opencollective.com/compodoc/backers.svg
|
120 | [sponsors-image]: https://opencollective.com/compodoc/sponsor.svg
|
121 | [github-action-badge]: https://github.com/compodoc/compodoc/workflows/CI/badge.svg
|
122 |
|
\ | No newline at end of file |