[opensourcedex]

react-docgen is a free, open source documentation & knowledge base project written in TypeScript and released under MIT. It has 3,820 GitHub stars, 315 forks and 104 open issues, and was last pushed 5 hours ago. On this registry it ranks #33 of 91 tracked projects in Documentation & Knowledge Base, with 5 head-to-head comparisons available.

react-docgen

react-docgen is a highly customizable library that extracts information from React components and returns this information in a structured machine readable format from which documentations can be generated.

@react-docgen/cli is a cli wrapper around the library allowing using react-docgen on the command line.

Typescript

See this issue about the status of TypeScript.

Documentation

For version 5.x please checkout the README.md on the 5.x branch

For version 6.x and newer please visit react-docgen.dev

License

This project is licensed under the MIT License.

Frequently asked questions

Is react-docgen free to use?

react-docgen is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does react-docgen do?

A CLI and library to extract information from React component files for documentation generation purposes.

What is react-docgen written in?

react-docgen is primarily written in TypeScript. Its source is publicly available at https://github.com/reactjs/react-docgen, and it has 3,820 GitHub stars.