props-table
v1.1.0
Published
Uses react-docgen to generate a markdown formatted prop table
Downloads
4
Readme
props-tables
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 uniqueprops
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.