React style guide generator
JavaScript CSS HTML

Readme.md

React Styleguidist

Build Status npm Join the chat at https://gitter.im/styleguidist/styleguidist

React Styleguidist is a style guide generator for React components. It lists component propTypes and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server. Check out the demo style guide.

Based on Webpack, webpack-dev-server and Babel.

Documentation

Examples

Showcase

Real projects using React Styleguidist:

Integration with other tools

Resources

Changelog

The changelog can be found on the Releases page.

Contributing

Everyone is welcome to contribute. Please take a moment to review the contributing guidelines.

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file.