@compodoc/compodoc
Version:
The missing documentation tool for your Angular application
314 lines (263 loc) • 17 kB
HTML
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>@compodoc/compodoc documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="./images/favicon.ico">
<link rel="stylesheet" href="./styles/style.css">
<link rel="stylesheet" href="./styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');
function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}
function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}
checkToggle(state);
const hasClass = document.body.classList.contains('dark');
if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}
useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>
<script>
// --- Iframe navigation tracking for Template Playground ---
function sendCurrentUrlToParent() {
if (window.parent && window.parent !== window) {
window.parent.postMessage({
type: 'compodoc-iframe-navigate',
url: window.location.pathname + window.location.hash
}, '*');
}
}
window.addEventListener('hashchange', sendCurrentUrlToParent, false);
window.addEventListener('popstate', sendCurrentUrlToParent, false);
window.addEventListener('DOMContentLoaded', sendCurrentUrlToParent, false);
</script>
<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="./" class="navbar-brand">@compodoc/compodoc documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content readme">
<div class="content-data">
<p align="center">
<img src="https://avatars3.githubusercontent.com/u/23202313" alt="Compodoc: The missing documentation tool for your Angular application" width="226">
<br/>
<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>
<a href="https://codecov.io/gh/compodoc/compodoc"><img src="https://codecov.io/gh/compodoc/compodoc/branch/develop/graph/badge.svg" alt="Codecov"/></a>
<a href="https://www.npmjs.com/package/@compodoc/compodoc"><img src="https://badge.fury.io/js/%40compodoc%2Fcompodoc.svg" alt="npm badge"/></a>
<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>
<a href="https://snyk.io/test/github/compodoc/compodoc"><img src="https://snyk.io/test/github/compodoc/compodoc/badge.svg" alt="Known Vulnerabilities"/></a>
<br/>
<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>
<a href="https://opensource.org/licenses/MIT"><img src="http://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT badge"/></a>
<br/>
<a href="#backers"><img src="https://opencollective.com/compodoc/backers/badge.svg" alt="sponsors on Open Collective" /></a> <a href="#sponsors"><img src="https://opencollective.com/compodoc/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
</p>
<p align="center">
<img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge"/>
</p>
<p align="center">
<a href="https://gitter.im/compodoc/compodoc" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"/></a><br><br>
</p>
<p align="center">The missing documentation tool for your Angular application.<br><br></p>
<p align="center">
<img src="https://raw.githubusercontent.com/compodoc/compodoc/master/screenshots/main-view.gif" alt="Compodoc: The missing documentation tool for your Angular application"/>
</p>
<h1>Live Demo</h1>
<p>A live demo is available — <strong><a href="https://compodoc.github.io/compodoc-demo-todomvc-angular/">see it in action</a></strong> !</p>
<p>The demo features documentation generated for a simple <a href="https://github.com/compodoc/compodoc-demo-todomvc-angular">TodoMVC application</a>.</p>
<h1>Features</h1>
<ul>
<li><p><strong>Clean, simple design</strong> — Navigate the documentation on the left side, read it on the right.</p>
</li>
<li><p><strong>Beautiful themes</strong> — Seven themes are available from well known documentation tools like <a href="https://www.gitbook.com">Gitbook</a>, <a href="https://readthedocs.org/">Read the Docs</a> and projects like <a href="https://www.vagrantup.com/docs/">Vagrant</a>, <a href="https://laravel.com/docs/5.3">Laravel</a>, <a href="https://developer.postmarkapp.com/">Postmark</a> and <a href="https://stripe.com/docs/api">Stripe</a>.</p>
</li>
<li><p><strong>Search</strong> — Includes a powerful search engine (<a href="https://lunrjs.com/">lunr.js</a>) for easily finding what you're looking for.</p>
</li>
<li><p><strong>Automatic table of contents</strong> — API table of contents is generated using elements found during files parsing.</p>
</li>
<li><p><strong>JSDoc light support</strong> — Support for <code>@param</code>, <code>@returns</code>, <code>@link</code>, <code>@ignore</code> and <code>@example</code> tags.</p>
</li>
<li><p><strong>Documentation coverage</strong> — Get the documentation coverage report of your project.</p>
</li>
<li><p><strong>Angular CLI-friendly</strong> — Supports <a href="https://cli.angular.io/">Angular CLI</a> projects out-of-the-box.</p>
</li>
<li><p><strong>Offline</strong> — No server needed, no sources uploaded online, documentation generated entirely offline.</p>
</li>
<li><p><strong>Open-source and on npm</strong> — Use it directly in your project using <a href="https://www.npmjs.com/">npm</a> and a single script—that's it!</p>
</li>
</ul>
<h1>Documentation</h1>
<p>Official documentation has moved to <a href="https://compodoc.github.io/website/guides/getting-started.html">https://compodoc.github.io/website/</a>.</p>
<h1>Installation</h1>
<p>Ready to get started? <a href="https://compodoc.github.io/website/guides/installation.html">Read installation instructions</a>.</p>
<h1>🏅 Backers</h1>
<p>Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. <a href="https://opencollective.com/compodoc#support">Become a backer</a></p>
<p><a href="https://opencollective.com/compodoc#support"><img src="https://opencollective.com/compodoc/backers.svg" alt="Backers" class="img-responsive"></a></p>
<h1>🎖 Sponsors</h1>
<p>Support this project by becoming a sponsor. Your logo will show up here with a link to your website. <a href="https://opencollective.com/compodoc#support">Become a sponsor</a></p>
<p><a href="https://opencollective.com/compodoc#support"><img src="https://opencollective.com/compodoc/sponsor.svg" alt="Sponsors" class="img-responsive"></a></p>
<h1>Contributing</h1>
<p>Want to file a bug, contribute some code, or improve documentation? Excellent!</p>
<p>Read up on our guidelines for <a href="https://github.com/compodoc/compodoc/blob/master/CONTRIBUTING.md">contributing</a>.</p>
<h1>Contributors</h1>
<p>This project exists thanks to all these people.</p>
<table class="table table-bordered compodoc-table">
<thead>
<tr>
<th align="center"><a href="https://github.com/vogloblinsky"><img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/2841805?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/manekinekko"><img alt="manekinekko" src="https://avatars3.githubusercontent.com/u/1699357?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/tcorral"><img alt="tcorral" src="https://avatars.githubusercontent.com/u/802081?v=4" width="117"/></a></th>
<th align="center"><a href="https://github.com/mattlewis92"><img alt="mattlewis92" src="https://avatars1.githubusercontent.com/u/6425649?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/JonasMH"><img alt="JonasMH" src="https://avatars0.githubusercontent.com/u/1939229?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/rprotsyk"><img alt="rprotsyk" src="https://avatars0.githubusercontent.com/u/104502?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/daniele-zurico"><img alt="daniele-zurico" src="https://avatars0.githubusercontent.com/u/3193095?v=4&s=117" width="117"/></a></th>
</tr>
</thead>
<tbody>
<tr>
<td align="center"><a href="https://github.com/vogloblinsky">vogloblinsky</a></td>
<td align="center"><a href="https://github.com/manekinekko">manekinekko</a></td>
<td align="center"><a href="https://github.com/tcorral">tcorral</a></td>
<td align="center"><a href="https://github.com/mattlewis92">mattlewis92</a></td>
<td align="center"><a href="https://github.com/JonasMH">JonasMH</a></td>
<td align="center"><a href="https://github.com/rprotsyk">rprotsyk</a></td>
<td align="center"><a href="https://github.com/daniele-zurico">daniele-zurico</a></td>
</tr>
</tbody>
</table>
<table class="table table-bordered compodoc-table">
<thead>
<tr>
<th align="center"><a href="https://github.com/profimedica"><img alt="profimedica" src="https://avatars0.githubusercontent.com/u/2903499?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/dp-1a"><img alt="vogloblinsky" src="https://avatars3.githubusercontent.com/u/32763448?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/ValentinGot"><img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/14924373?v=4&s=117" width="117"/></a></th>
<th align="center"><a href="https://github.com/Blakesalot"><img alt="Blakesalot" src="https://avatars1.githubusercontent.com/u/10159693?s=460&v=4" width="117"/></a></th>
<th align="center"><a href="https://github.com/bhofmei"><img alt="Brigitte Hofmeister" src="https://avatars1.githubusercontent.com/u/16089658?s=460&v=4" width="117"/></a></th>
<th align="center"><a href="https://github.com/lichangfeng"><img alt="lichangfeng" src="https://avatars2.githubusercontent.com/u/8101989?s=460&v=4" width="117"/></a></th>
<th align="center"><a href="https://github.com/guilhermevrs"><img alt="guilhermevrs" src="https://avatars0.githubusercontent.com/u/1570567?v=4&s=117" width="117"/></a></th>
</tr>
</thead>
<tbody>
<tr>
<td align="center"><a href="https://github.com/profimedica">profimedica</a></td>
<td align="center"><a href="https://github.com/dp-1a">dp-1a</a></td>
<td align="center"><a href="https://github.com/ValentinGot">ValentinGot</a></td>
<td align="center"><a href="https://github.com/Blakesalot">Blake Simmon</a></td>
<td align="center"><a href="https://github.com/bhofmei">Brigitte Hofmeister</a></td>
<td align="center"><a href="https://github.com/lichangfeng">lichangfeng</a></td>
<td align="center"><a href="https://github.com/guilhermevrs">guilhermevrs</a></td>
</tr>
</tbody>
</table>
<h1>Big Thanks</h1>
<p>Cross-browser Testing Platform and Open Source <3 Provided by <a href="https://saucelabs.com">Sauce Labs</a></p>
<h1>License</h1>
<p>Everything in this repository is <a href="https://github.com/compodoc/compodoc/blob/master/LICENSE">licensed under the MIT License</a> unless otherwise specified.</p>
<p>Copyright (c) 2016 – 2025 <a href="https://www.vincentogloblinsky.com">Vincent Ogloblinsky</a></p>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 0;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'readme';
var COMPODOC_CURRENT_PAGE_URL = 'index.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>
<script src="./js/libs/custom-elements.min.js"></script>
<script src="./js/libs/lit-html.js"></script>
<script src="./js/menu-wc.js" defer></script>
<script nomodule src="./js/menu-wc_es5.js" defer></script>
<script src="./js/libs/bootstrap-native.js"></script>
<script src="./js/libs/es6-shim.min.js"></script>
<script src="./js/libs/EventDispatcher.js"></script>
<script src="./js/libs/promise.min.js"></script>
<script src="./js/compodoc.js"></script>
<script src="./js/tabs.js"></script>
<script src="./js/menu.js"></script>
<script src="./js/libs/clipboard.min.js"></script>
<script src="./js/libs/prism.js"></script>
<script src="./js/sourceCode.js"></script>
<script src="./js/search/search.js"></script>
<script src="./js/search/lunr.min.js"></script>
<script src="./js/search/search-lunr.js"></script>
<script src="./js/search/search_index.js"></script>
<script src="./js/lazy-load-graphs.js"></script>
</body>
</html>