Skip to content

Commit 3347914

Browse files
committed
Update readme
1 parent 23c2977 commit 3347914

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
# react-docgen
22

3-
`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.
46

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.
138

149
## Documentation
1510

1611
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)
1712

1813
For version 6.x please checkout [react-docgen.dev](https://react-docgen.dev)
1914

15+
Version 6 is currently only available as alpha version (latest being `6.0.0-alpha.4`)
16+
2017
## License
2118

2219
This project is licensed under the MIT License.

packages/website/pages/index.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
import { Callout } from "nextra-theme-docs";
1+
import { Callout } from 'nextra-theme-docs';
22

33
# Welcome to react-docgen!
44

55
<Callout emoji="🚧">This website is under construction</Callout>
66

77
`react-docgen` is a highly customizable library that extracts information from
88
[React](https://reactjs.org/) components and returns this information in a
9-
structured machine readable documentation.
9+
structured machine readable format from which documentations can be generated.
1010

1111
It uses [Babel](https://babel.dev/) to parse the source into an AST and provides
1212
methods to process this AST to extract the desired information. The output /
@@ -27,5 +27,4 @@ to be analyzable (see below for more info).
2727
tools using react-docgen.)
2828
</Callout>
2929

30-
[classes]:
31-
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes
30+
[classes]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes

0 commit comments

Comments
 (0)