react-docgen

A CLI and library to extract information from React component files for doc...

README

react-docgen


[react-docgen](./packages/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](./packages/react-docgen-cli/) is a cli wrapper around the library allowing using react-docgen on the command line.

Documentation


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

For version 6.x please checkout react-docgen.dev

Version 6 is currently only available as alpha version (latest being 6.0.0-beta.5)

License


This project is licensed under the MIT License.