React Showroom

Document React components by declaring props definition and writing markdown.

npm install -D react-showroom

Code-first documentation

Auto generate documentations for your component props from the component's TypeScript definition.

Standard language

Write markdown (or MDX) to show examples to use the component, which will become an editable playground.


Ensure the components are SSR-friendly - the examples can be pre-render on build time.