Autodocs
The Storybook feature that builds a documentation page for a component from its stories, TypeScript types and JSDoc comments.
In more detail
Because the page is generated from the code, its props table and examples stay current as the component changes. It is turned on by adding the autodocs tag to a component's stories.
Related terms
- Storybook — An open-source workshop where you develop, view and test components in isolation, one story per state.
- JSDoc — A convention for writing documentation comments above JavaScript and TypeScript code, using tags such as @param and @deprecated.
- TypeScript — JavaScript with added type annotations, checked by a compiler before the code runs.
Taught in
- Storybook & Component Driven Development Workflows — Design Systems & Component Engineering