You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
`react-docgen` is a CLI and toolbox to help extracting information from [React][] components, and generate documentation from it.
3
+
[`react-docgen`](./packages/react-docgen/) is a highly customizable library that extracts information from
4
+
[React](https://reactjs.org/) components and returns this information in a
5
+
structured machine readable format from which documentations can be generated.
4
6
5
-
It uses [@babel/parser][] to parse the source into an AST and provides methods to process this AST to extract the desired information. The output / return value is a JSON blob / JavaScript object.
6
-
7
-
It provides a default implementation for React components defined via
8
-
`React.createClass`, [ES2015 class definitions][classes] or functions
9
-
(stateless components). These component definitions must follow certain
10
-
guidelines in order to be analyzable (see below for more info).
11
-
12
-
> react-docgen is a low level tool to extract information about react components. If you are searching for a more high level styleguide with nice interface try [react-styleguidist](https://github.com/styleguidist/react-styleguidist) or any of the other tools listed in the [wiki](https://github.com/reactjs/react-docgen/wiki).
7
+
[`@react-docgen/cli`](./packages/react-docgen-cli/) is a cli wrapper around the library allowing using `react-docgen` on the command line.
13
8
14
9
## Documentation
15
10
16
11
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)
17
12
18
13
For version 6.x please checkout [react-docgen.dev](https://react-docgen.dev)
19
14
15
+
Version 6 is currently only available as alpha version (latest being `6.0.0-alpha.4`)
0 commit comments