Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-docgen

reactjs26mMIT8.0.0TypeScript support: included

A library to extract information from React components for documentation generation.

react, documentation, documentation-generation

readme

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.

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.