Skip to content
📔 The missing documentation tool for your Angular, Nest & Stencil application
TypeScript HTML JavaScript CSS
Branch: develop
Clone or download

Latest commit

vogloblinsky Merge pull request #924 from TMakaku/develop
Angular lazy loading fix - extra undefined check in router-parser
Latest commit 18e8b27 Mar 8, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update FUNDING.yml Oct 11, 2019
bin feat(app): refactoring with DDD / ts-morph in mind Jul 12, 2019
docs fix(doc): cleaning Jul 11, 2019
rollup fix(app): comsiconfig update and sync APIs Nov 5, 2019
screenshots feat(chore): update screenshots Dec 31, 2018
src-refactored fix(cli): tsconfig with files and include entries Nov 5, 2019
src extra undefined check in router-parser Mar 5, 2020
test fix(coverage): function links in documentation coverage are broken Nov 5, 2019
tools chore(tools): ngd tests Feb 15, 2019
.editorconfig chore: add .editorconfig Sep 24, 2018
.eslintrc.json feat(app): tslint to eslint Sep 26, 2019
.gitignore feat(app): merge lcov Jul 17, 2019
.madgerc feat(app): refactoring flags setup Jul 15, 2019
.npmignore fix(app): refactoring npm ignore Oct 15, 2019
.nycrc fix(app): cleaning devDep Jul 11, 2019
.nycrc-refactoring feat(app): bump dependencies / test-refactoring coverage Oct 16, 2019
.prettierignore feat(app): run prettier on files + pre-commit Jan 15, 2019
.prettierrc feat(app): run prettier on files + pre-commit Jan 15, 2019
.travis.yml fix(test): sonar issue with typescript Oct 16, 2019
CHANGELOG.md 1.1.11 Oct 15, 2019
CNAME chore: configure the compodoc.app domain May 16, 2018
CONTRIBUTING.md max-search-results-811, Fixing issue 811 for adding a max search results Jul 17, 2019
DONTUPDATE.md feat(app): bump dependencies Aug 12, 2019
LICENSE Update license Feb 4, 2019
README.md feat(app): doc Jul 11, 2019
TODOS.md feat(app): NOTES Jul 16, 2019
appveyor.yml feat(app): remove CI Node.js 11 Sep 10, 2019
codecov.yml Fixed coverage Oct 14, 2017
package-lock.json feat(app): bump dependencies Nov 5, 2019
package.json feat(app): bump dependencies Nov 5, 2019
sonar-project.properties fix(test): sonar issue with typescript Oct 16, 2019
tsconfig.json fix(app): refactoring tested with mocha Sep 28, 2019

README.md

Compodoc: The missing documentation tool for your Angular application
Linux Build Status Windows Build Status Codecov npm badge Quality Gate Status
npm dependencies npm devDependencies
NPM Downloads MIT badge

saucelabs badge

Gitter badge

The missing documentation tool for your Angular application.

Compodoc: The missing documentation tool for your Angular application

Live Demo

A live demo is available — see it in action !

The demo features documentation generated for a simple TodoMVC application.

Features

  • 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!

Documentation

Official documentation has moved to https://compodoc.github.io/website/.

Installation

Ready to get started? Read installation instructions.

🏅 Backers

Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. Become a backer

Backers

🎖 Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

Sponsors

Contributing

Want to file a bug, contribute some code, or improve documentation? Excellent!

Read up on our guidelines for contributing.

Contributors

This project exists thanks to all these people.

vogloblinsky manekinekko mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky manekinekko mattlewis92 JonasMH rprotsyk daniele-zurico profimedica guilhermevrs
vogloblinsky guilhermevrs Blakesalot Brigitte Hofmeister lichangfeng
dp-1a ValentinGot Blake Simmon Brigitte Hofmeister lichangfeng

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

License

Everything in this repository is licensed under the MIT License unless otherwise specified.

Copyright (c) 2016 – 2019 Vincent Ogloblinsky

You can’t perform that action at this time.