|
3 months ago | |
---|---|---|
.. | ||
.tmp-compodoc-test-big-app | 3 months ago | |
.tmp-compodoc-test-tsconfig | 3 months ago | |
.tmp-compodoc-test-unit-test | 3 months ago | |
bin | 3 months ago | |
coverage-refactoring | 3 months ago | |
dist | 3 months ago | |
schematics | 3 months ago | |
src | 3 months ago | |
test-typedoc | 3 months ago | |
testCoverage | 3 months ago | |
.editorconfig | 3 months ago | |
.eslintrc.json | 3 months ago | |
.madgerc | 3 months ago | |
.ncurc.json | 3 months ago | |
.nycrc | 3 months ago | |
.nycrc-refactoring | 3 months ago | |
.prettierignore | 3 months ago | |
.renovaterc.json | 3 months ago | |
CHANGELOG.md | 3 months ago | |
LICENSE | 3 months ago | |
README.md | 3 months ago | |
TODOS.md | 3 months ago | |
package.json | 3 months ago | |
sonar-project.properties | 3 months ago | |
tsconfig.test.json | 3 months ago | |
wdio-saucelabs.conf.js | 3 months ago | |
wdio.conf.js | 3 months ago |
The missing documentation tool for your Angular application.
A live demo is available — see it in action !
The demo features documentation generated for a simple TodoMVC application.
Clean, simple design — Navigate the documentation on the left side, read it on the right.
Beautiful themes — Seven themes are available from well known documentation tools like Gitbook, Read the Docs and projects like Vagrant, Laravel, Postmark and Stripe.
Search — Includes a powerful search engine (lunr.js) for easily finding what you're looking for.
Automatic table of contents — API table of contents is generated using elements found during files parsing.
JSDoc light support — Support for @param
, @returns
, @link
, @ignore
and @example
tags.
Documentation coverage — Get the documentation coverage report of your project.
Angular CLI-friendly — Supports Angular CLI projects out-of-the-box.
Offline — No server needed, no sources uploaded online, documentation generated entirely offline.
Open-source and on npm — Use it directly in your project using npm and a single script—that's it!
Official documentation has moved to https://compodoc.github.io/website/.
Ready to get started? Read installation instructions.
Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. Become a backer
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor
Want to file a bug, contribute some code, or improve documentation? Excellent!
Read up on our guidelines for contributing.
This project exists thanks to all these people.
vogloblinsky | manekinekko | mattlewis92 | JonasMH | rprotsyk | daniele-zurico | profimedica |
dp-1a | ValentinGot | Blake Simmon | Brigitte Hofmeister | lichangfeng | guilhermevrs |
Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs
Everything in this repository is licensed under the MIT License unless otherwise specified.
Copyright (c) 2016 – 2019 Vincent Ogloblinsky