reactjs/react-docgen
A CLI and library to extract information from React component files for documentation generation purposes. observed · 2026-08-28
Health v2 · maintenance only
90/100
- Activity 99
- Release rhythm 74
- Longevity 100
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-09-03. Adoption (stars, forks) is never an input.
- gap_med: 23
- age_days: 4205
- days_rel: 173
- days_push: 7
- n_releases_24m: 16
Adoption not part of the score
3820 stars · 314 forks observed · 2026-08-28
What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-29, confidence not recorded
react-docgen is a highly customizable library and CLI that parses React component source files (via Babel) and extracts structured, machine-readable JSON documentation about components, including props, methods, and docblocks. It supports React.createClass, ES2015 classes, and function components, with PropTypes, TypeScript, and Flow type information.
Use cases
- extract props documentation from React components
- generate JSON metadata for a component style guide
- document React component APIs automatically
- parse PropTypes and TypeScript types from component files
- build custom React documentation tooling
- run docgen from the command line over a components directory
When to choose
- you need low-level, customizable extraction of React component metadata
- you are building a documentation generator or style guide tool
- you want a CLI to batch-analyze component files into JSON
- you need support for PropTypes, TypeScript, and Flow types
When to avoid
- you want a full-fledged style guide with a rendered UI out of the box
- your project is not React-based
- you need documentation for non-component code like utilities or hooks only
Facets
library · maturity active
documentation parser cli developer-tools frontend documentation developer-tools cli cross-platform react docgen props-extraction babel -output typescript flow nodejs
10 sources
- readme: https://github.com/reactjs/react-docgen · fetched 2026-08-28 · 7b28d9f71791
- homepage: https://react-docgen.dev · fetched 2026-08-29 · 35b069cafd67
- site_page: https://react-docgen.dev/docs/getting-started/nodejs · fetched 2026-08-29 · a4f9b4c9fa77
- site_page: https://react-docgen.dev/about · fetched 2026-08-29 · 27c1992dfbe3
- site_page: https://react-docgen.dev/docs/getting-started/cli · fetched 2026-08-29 · e68335c0f52e
- site_page: https://react-docgen.dev/docs/extending/architecture · fetched 2026-08-29 · d34a4b7db899
- site_page: https://react-docgen.dev/docs/extending/resolver · fetched 2026-08-29 · 833a3bd26d63
- site_page: https://react-docgen.dev/docs/extending/handler · fetched 2026-08-29 · 76a01a85164c
- site_page: https://react-docgen.dev/docs/extending/importer · fetched 2026-08-29 · 92ac4f917006
- site_page: https://react-docgen.dev/docs/reference/config · fetched 2026-08-29 · cfe237e718f9
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| reactjs/react-docgen | main | 90 |
For agents
markdown · JSON · MCP: product_card(name="reactjs/react-docgen")
Data as of 2026-08-30T08:39:29.467469+00:00 · Report a problem