← All tools

@react-docgen/cli

Popularity 65 Updated Development & Build

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

npmauto-collected

Installation

npm
npm install -g @react-docgen/cli

Install with npm.

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.