Generate your Angular project documentation in seconds.
Compodoc comes with a lot of features. Check it out now !
Compodoc supports all major APIs of Angular
Use it directly in your project using npm and one script, that's it !
No server needed, no sources uploaded online
7 themes are available from famous documentation tools like Gitbook, Read the Docs or projects like Vagrant, Laravel, Postmark and Stripe
Compodoc include a powerful search engine (lunr.js) for easily finding your information
The generated pages display very well on mobile, tablet and desktop
The generated documentation contains structured data suitable for LLMs (Large Language Models) processing
The generated pages display very well in dark mode
# Install compodoc with npm
$ npm install -g @compodoc/compodoc
# Create a file named tsconfig.doc.json, containing "include": ["src/**/*.ts"]
# Run compodoc in your project (generated with Angular CLI for example) and serve it
$ compodoc -p tsconfig.doc.json -s