https://github.com/reactjs/react-docgen

A CLI and library to extract information from React component files for documentation generation purposes.
https://github.com/reactjs/react-docgen

docgen documentation json react reactjs

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/reactjs/react-docgen
• Owner: reactjs
• License: mit
• Created: 2015-02-27T22:03:34.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T07:46:53.000Z (about 2 months ago)
• Last Synced: 2024-10-29T09:08:51.087Z (about 2 months ago)
• Topics: docgen, documentation, json, react, reactjs
• Language: TypeScript
• Homepage: https://react-docgen.dev
• Size: 13.3 MB
• Stars: 3,666
• Watchers: 49
• Forks: 296
• Open Issues: 111
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-tech-stack - react-docgen
• awesome - react-docgen - A CLI and toolbox to extract information from React component files for documentation generation purposes. (JavaScript)
• awesome-designops - React docgen - extract documentation from React components. (Design System Tools / Components)
• awesome - reactjs/react-docgen - A CLI and library to extract information from React component files for documentation generation purposes. (TypeScript)
• awesome-list - react-docgen
• stars - react-docgen
• stars - react-docgen

README

        
# react-docgen

[`react-docgen`](./packages/react-docgen/) is a highly customizable library that

extracts information from [React](https://reactjs.org/) 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](https://github.com/reactjs/react-docgen/blob/5.x/README.md)

For version 6.x and newer please visit

[react-docgen.dev](https://react-docgen.dev)

## License

This project is licensed under the MIT License.