fallenleavesguy / react-docgen

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

Home Page:https://react-docgen.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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 please visit react-docgen.dev

License

This project is licensed under the MIT License.

About

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

https://react-docgen.dev

License:MIT License


Languages

Language:TypeScript 97.8%Language:JavaScript 2.2%Language:CSS 0.0%