@jswork/react-markdown-props

react-markdown-props

Generate markdown properties string.

installation

npm install -S @jswork/react-markdown-props

usage

import rmp from '@jswork/react-markdown-props';

rmp('./src/components/index.js');

// output
| Name        | Type   | Required | Default | Description                                 |
| ----------- | ------ | -------- | ------- | ------------------------------------------- |
| className   | string | false    | -       | The extended className for component.       |
| value       | object | false    | null    | Default value.                              |
| onChange    | func   | false    | noop    | The change handler.                         |
| destroyable | bool   | false    | -       | If element destroyed when visible to false. |
| backdrop    | union  | false    | -       | Backdrop props or not display backdrop.     |

resources

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

license

Code released under the MIT license.