compodoc
ngd
Our great sponsors
| compodoc | ngd | |
|---|---|---|
| 20 | 1 | |
| 3,952 | 610 | |
| 0.5% | 0.5% | |
| 8.2 | 1.5 | |
| 4 days ago | 11 months ago | |
| TypeScript | TypeScript | |
| MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
compodoc
- What documentation generator do you use for Angular libraries?
-
The best Angular 15 Starter Project
✅ Angular 15 ✅ Angular Material ✅ Unit Testing with Jest ✅ End-to-End Testing with [TestCafé](https://testcafe.io/ ✅ Internationalization with Transloco ✅ Auto documentation with Compodoc ✅ Analyse your project with webpack-bundle-analyzer ✅ Docker ✅ ESLint ✅ Prettier ✅ Commit Linting ✅ AuditJS Audit this application using Sonatype OSS Index ✅ Auto-generate a CHANGELOG with auto-changelog
-
Documentation culture
Properly written code, there are documentation tool like this for Angular and others. https://compodoc.app/
-
Are there any Angular Modules, components, services relationship Mapping tools? Apart from Angular Augury.
Compodoc is a good tool for generating docs for an angular project. The documents generated also includes visual maps of dependencies.
-
I write more documents than code, but it comes with its struggles. Do you feel the same?
App documentation, here is compodoc (https://compodoc.app/) It is generated when the dev does a git commit and build in the pipeline.
-
Documenting Angular projects
Finally, we have come to a point where we want our JSDoc comment documentations to turn into a full scale documentation website, which we can share with new developers instead of providing lengthy Word documents, or which can be used by the team to search for explanations and direction during development. Thankfully, there are amazing tools that help us build such sites easily, with just a console command. Today we will be exploring one such tool called Compodoc, which is a documentation website generator specifically designed for Angular projects (it also supports Nest and Stencil, but we will focus on Angular).
-
Which tool for code documentation has worked best for you in an environment based on Nrwl/Nx, Angular, NestJS and TypeScript?
We use Compodoc in our applications. You write JSDoc comments and it does the hard work of creating the documentation for you.
-
🚀 Angular 13 + ESLint, Material + Transloco + Jest, TestCafe + Docker + Prettier 🚀
npm run compodoc - generate compodoc documentation
-
The best Angular 13 Starter Project
✅ Angular 13 ✅ Angular Material ✅ Unit Testing with Jest ✅ End-to-End Testing with [TestCafé](https://testcafe.io/ ✅ Internationalization with Transloco ✅ Auto documentation with Compodoc ✅ Analyse your project with webpack-bundle-analyzer ✅ Docker ✅ ESLint ✅ Prettier ✅ Commit Linting ✅ AuditJS Audit this application using Sonatype OSS Index ✅ Auto-generate a CHANGELOG with auto-changelog
-
Architecture Diagraming Tools
Not too sure about a diagramming tool for a new project, but I've used compodoc to automatically generate documentation and diagrams for existing Angular apps before and would definitely recommend checking it out
ngd
-
Angular Tooling - How to equip before starting a project
Compodoc NGD Documentation
What are some alternatives?
storybook - 📓 The UI component explorer. Develop, document, & test React, Vue, Angular, Web Components, Ember, Svelte & more! [Moved to: https://github.com/storybookjs/storybook]
statoscope - Statoscope is a toolkit to analyze and validate webpack bundle
tsdoc - A doc comment standard for TypeScript
dag - 🐠 An Angular service for managing directed acyclic graphs
ngx-virtual-scroller - Virtual Scroll displays a virtual, "infinite" list.
graphy-ng - Library for rendering directed graphs in Angular.
vscode-docthis - JSDoc generator extension for Visual Studio Code.
ts_injector - Simple and lightweight injector for typescript projects.
webpack-bundle-analyzer - Webpack plugin and CLI utility that represents bundle content as convenient interactive zoomable treemap
skott - All-in-one devtool to automatically analyze, search and visualize dependencies from JavaScript, TypeScript (JSX/TSX) and Node.js (ES6, CommonJS)
ESLint - Find and fix problems in your JavaScript code.
d3-graph-controller - A TypeScript library for visualizing and simulating directed, interactive graphs.