https://github.com/afeiship/react-markdown-props
Generate markdown properties string.
https://github.com/afeiship/react-markdown-props
docs properties react react-docgen
Last synced: 6 months ago
JSON representation
Generate markdown properties string.
- Host: GitHub
- URL: https://github.com/afeiship/react-markdown-props
- Owner: afeiship
- License: mit
- Created: 2020-01-28T15:24:24.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-07T01:58:34.000Z (over 5 years ago)
- Last Synced: 2025-09-10T08:37:48.968Z (7 months ago)
- Topics: docs, properties, react, react-docgen
- Language: JavaScript
- Size: 18.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# react-markdown-props
> Generate markdown properties string.
[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]
## installation
```shell
npm install -S @jswork/react-markdown-props
```
## usage
```js
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](https://github.com/afeiship/react-markdown-props/blob/master/LICENSE.txt).
[version-image]: https://img.shields.io/npm/v/@jswork/react-markdown-props
[version-url]: https://npmjs.org/package/@jswork/react-markdown-props
[license-image]: https://img.shields.io/npm/l/@jswork/react-markdown-props
[license-url]: https://github.com/afeiship/react-markdown-props/blob/master/LICENSE.txt
[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/react-markdown-props
[size-url]: https://github.com/afeiship/react-markdown-props/blob/master/dist/react-markdown-props.min.js
[download-image]: https://img.shields.io/npm/dm/@jswork/react-markdown-props
[download-url]: https://www.npmjs.com/package/@jswork/react-markdown-props