props-table

1.1.0 • Public • Published

props-tables

npm

Uses react-docgen to pull out docstrings for component props and operate on the results to:

  • Generate a Markdown props table for one (or many) files
  • Replace a custom pattern with the generated props table for injection into static docs
  • Generate an "API" docs page with all the components and their props in individual tables
  • Extract all props and print the unique props to get an overview of the entire library API

Caveats

(╯._.)╯︵ ┻━┻

  • Need a better way to grab the component name for the "everything on one page" API docs.

Dependencies (3)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i props-table

    Weekly Downloads

    6

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    5.96 kB

    Total Files

    10

    Last publish

    Collaborators

    • varl