1
1
<p align =" center " >
2
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 >
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
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://david-dm.org/compodoc/compodoc " ><img src =" https://david-dm.org/compodoc/compodoc.svg " alt =" npm dependencies " ></a >
9
- <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 >
10
- <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 >
11
- <a href =" https://opensource.org/licenses/MIT " ><img src =" http://img.shields.io/badge/license-MIT-brightgreen.svg " alt =" MIT badge " ></a >
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 " />
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://david-dm.org/compodoc/compodoc " ><img src =" https://david-dm.org/compodoc/compodoc.svg " alt =" npm dependencies " / ></a >
9
+ <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 >
10
+ <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 >
11
+ <a href =" https://opensource.org/licenses/MIT " ><img src =" http://img.shields.io/badge/license-MIT-brightgreen.svg " alt =" MIT badge " / ></a >
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
13
</p >
14
14
<p align =" center " >
15
- <img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge">
15
+ <img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge"/ >
16
16
</p >
17
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>
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
19
</p >
20
20
21
21
<p align =" center " >The missing documentation tool for your Angular application.<br ><br ></p >
22
22
23
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 " >
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
25
</p >
26
26
27
-
28
27
# Live Demo
29
28
30
29
A live demo is available — ** [ see it in action] [ demo ] ** !
31
30
32
31
The demo features documentation generated for a simple [ TodoMVC application] .
33
32
34
33
[ demo ] : https://compodoc.github.io/compodoc-demo-todomvc-angular/
35
- [ TodoMVC application] : https://github.com/compodoc/compodoc-demo-todomvc-angular
34
+ [ todomvc application] : https://github.com/compodoc/compodoc-demo-todomvc-angular
36
35
37
36
# Features
38
37
39
- - ** Clean, simple design** — Navigate the documentation on the left side, read it on the right.
38
+ - ** Clean, simple design** — Navigate the documentation on the left side, read it on the right.
40
39
41
- - ** Beautiful themes** — Seven themes are available from well known documentation tools like [ Gitbook] , [ Read the Docs] and projects like [ Vagrant] , [ Laravel] , [ Postmark] and [ Stripe] .
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] .
42
41
43
- - ** Search** — Includes a powerful search engine ([ lunr.js] ) for easily finding what you're looking for.
42
+ - ** Search** — Includes a powerful search engine ([ lunr.js] ) for easily finding what you're looking for.
44
43
45
- - ** Automatic table of contents** — API table of contents is generated using elements found during files parsing.
44
+ - ** Automatic table of contents** — API table of contents is generated using elements found during files parsing.
46
45
47
- - ** JSDoc light support** — Support for ` @param ` , ` @returns ` , ` @link ` , ` @ignore ` and ` @example ` tags.
46
+ - ** JSDoc light support** — Support for ` @param ` , ` @returns ` , ` @link ` , ` @ignore ` and ` @example ` tags.
48
47
49
- - ** Documentation coverage** — Get the documentation coverage report of your project.
48
+ - ** Documentation coverage** — Get the documentation coverage report of your project.
50
49
51
- - ** Angular CLI-friendly** — Supports [ Angular CLI] projects out-of-the-box.
50
+ - ** Angular CLI-friendly** — Supports [ Angular CLI] projects out-of-the-box.
52
51
53
- - ** Offline** — No server needed, no sources uploaded online, documentation generated entirely offline.
52
+ - ** Offline** — No server needed, no sources uploaded online, documentation generated entirely offline.
54
53
55
- - ** Open-source and on npm** — Use it directly in your project using [ npm] and a single script—that's it!
54
+ - ** Open-source and on npm** — Use it directly in your project using [ npm] and a single script—that's it!
56
55
57
- [ Gitbook ] : https://www.gitbook.com
58
- [ Read the Docs ] : https://readthedocs.org/
59
- [ Vagrant ] : https://www.vagrantup.com/docs/
60
- [ Laravel ] : https://laravel.com/docs/5.3
61
- [ Postmark ] : https://developer.postmarkapp.com/
62
- [ Stripe ] : https://stripe.com/docs/api
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
63
62
[ lunr.js ] : https://lunrjs.com/
64
- [ Angular CLI ] : https://cli.angular.io/
63
+ [ angular cli ] : https://cli.angular.io/
65
64
[ npm ] : https://www.npmjs.com/
66
65
67
66
# Documentation
@@ -94,13 +93,13 @@ Read up on our guidelines for [contributing](https://github.com/compodoc/compodo
94
93
95
94
This project exists thanks to all these people.
96
95
97
- |[<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)|
98
- | :-:| :-:| :-:| :-:| :-:| :-:| :-:| :-:|
99
- | [ 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 ) |
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) |
100
99
101
- | [ <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 ) |
102
- | :-: | :-: | :-: | :-: | :-: |
103
- | [ 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 ) |
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 ) |
104
103
105
104
# License
106
105
@@ -109,9 +108,7 @@ Everything in this repository is [licensed under the MIT License][license] unles
109
108
Copyright (c) 2016 – 2019 [ Vincent Ogloblinsky]
110
109
111
110
[ license ] : https://github.com/compodoc/compodoc/blob/master/LICENSE
112
- [ Vincent Ogloblinsky ] : https://www.vincentogloblinsky.com
113
-
114
-
111
+ [ vincent ogloblinsky ] : https://www.vincentogloblinsky.com
115
112
[ support-url ] : https://opencollective.com/compodoc#support
116
113
[ backers-image ] : https://opencollective.com/compodoc/backers.svg
117
114
[ sponsors-image ] : https://opencollective.com/compodoc/sponsors.svg
0 commit comments