Automatic UI Library Documentation with TypeScript AST
summary
Automatic generation of UI component documentation by parsing the TypeScript AST to extract inputs, outputs, public fields, methods and interfaces into JSON. It uses the TypeScript compiler API, TypeDoc, an AST traverser and webpack to render HTML and embed live Angular templates so docs and examples update automatically as source changes, reducing documentation effort to about one third.
AI-written summary · about
chapters (6)
- 0:00Shared component libraries
- 5:45UI library requirements
- 12:25Documenting components
- 18:30TypeScript AST and Compiler API
- 26:41Auto-documentation with TypeDoc
- 31:13Live examples
related talks
33mTypeScript for APIs
36mLet Your Angular Code Write Itself
46mTypeScript all the things!
33mHidden Gems of TypeScript compiler
24mReliable I/O with the TypeScript Compiler API
26mLearnings from building a component library
28mBuilding Considerate React Component APIs with TypeScript
17mTypeScript and Angular 20