UNPKG

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