Clean, simple design — With Compodoc, the main endpoints are on the left side of your documentation, and all the content is on the right side
Beautiful themes — 8 themes are available from famous documentation tools like Gitbook, Read the Docs or projects like Vagrant, Laravel, Postmark, Material design and Stripe.
i18n — Many languages available : de-DE, en-US, es-ES, fr-FR, hu-HU, it-IT, ja-JP, nl-NL, pl-PL, pt-BR, sk-SK, zh-CN
Search — Compodoc include a powerful search engine (lunr.js) for easily finding your information
Automatic table of contents - API table of contents is generated using elements found during file parsing
Open-source and on npm - Use it directly in your project using npm and one script, that's it !
A local tool - No server needed, no sources uploaded online
No TypeScript compilation - Compodoc just parses your code
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 - Compodoc supports out of the box Angular-CLI projects
Dark mode - Compodoc supports your web browser's dark mode out of the box
Guides