Socket
Socket
Sign inDemoInstall

@trickl/react-props-md-table

Package Overview
Dependencies
86
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @trickl/react-props-md-table

A markdown table generator for React component props.


Version published
Maintainers
1
Created

Readme

Source

react-props-md-table

This tiny tool uses react-docgen to generate markdown tables of the props of a React component.

Installation

npm i -g @trickl/react-props-md-table

Usage

Run the following command in the terminal to replace the props table in readme.md in the same directory.

props-table path/to/SomeComponent.js

The props table in the file needs to be wrapped between <!-- props-table-start --> and <!-- props-table-end --> for the replacement to work.

Options

  • --to-console will write the props table to the terminal instead of the file.
  • --force will write the props table at the end of the readme if no table wrapped by comments is found. The readme.md will be created if it doesn't exist.
  • --help or -h display usage options
  • --version or -v display version information

Keywords

FAQs

Last updated on 30 Jun 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc