Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an ability to generate "Props Reference" section based on PropTypes definition in component #20

Open
mpritchin-sc opened this issue Jan 29, 2018 · 1 comment
Assignees

Comments

@mpritchin-sc
Copy link

The main idea it's use propTypes definition of components for generationg "Props Reference" section in documentation.

Example:
PropTypes definition of component:

...
static propTypes = {
   /** Source value */
    value: PropTypes.string
};
...

Generated PropTypes section in documentation:

| Name               | Type            | Description                                     | Is required | 
| -----------------|------------- |-------------------------------------- |-------------|
| value                | string          |  Source value                                  |   false         |
| -----------------|------------- |-------------------------------------- |-------------|
@kvolkovich-sc
Copy link
Contributor

kvolkovich-sc commented Jan 29, 2018

Thanks, @mpritchin-sc. We'll consider your suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants