Skip to content

adamlaska/react-docgen

 
 

Repository files navigation

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.

About

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

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 87.2%
  • MDX 10.6%
  • JavaScript 2.2%