https://github.com/teamwertarbyte/react-props-md-table
A markdown table generator for React component props.
https://github.com/teamwertarbyte/react-props-md-table
documentation-tool markdown react
Last synced: 12 months ago
JSON representation
A markdown table generator for React component props.
- Host: GitHub
- URL: https://github.com/teamwertarbyte/react-props-md-table
- Owner: TeamWertarbyte
- Created: 2017-09-30T14:33:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-07T09:31:38.000Z (over 8 years ago)
- Last Synced: 2024-04-26T17:13:08.030Z (about 2 years ago)
- Topics: documentation-tool, markdown, react
- Language: JavaScript
- Size: 7.81 KB
- Stars: 6
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-props-md-table
This tiny tool uses [react-docgen][] to generate markdown tables of the props of a React component.
[react-docgen]: https://github.com/reactjs/react-docgen
## Installation
```
npm i -g @wertarbyte/react-props-md-table`
```
## Usage
```
props-table [-p] path/to/SomeComponent.js
```
| Option | Description |
|--------|--------------------------|
| `-p` | Pretty-print the output. |