effinrich/react-styleguidist

Isolated React component development environment with a living style guide

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component propTypes and shows live, editable usage examples based on Markdown files. Check out the demo style guide.

Usage

Getting Started: install and run Styleguidist
Documenting components: how to write documentation
Locating components: point Styleguidist to your React components
Configuring webpack: tell Styleguidist how to load your code
Cookbook: how to solve common tasks with Styleguidist

Advanced documentation

Examples

Basic style guide, source
Style guide with sections, source
Style guide with customized styles, source
Style guide with custom express endpoints, source
Create React App integration, source

Showcase

Real projects using React Styleguidist:

Integration with other tools

Create React App — supported out of the box, see the Getting Started guide
Vue, see Vue Styleguidist

Third-party tools

snapguidist: snapshot testing for React Styleguidist
react-styleguidist-visual: automated visual testing for React Styleguidist, using Puppeteer and pixelmatch
styleguidist-scrapper: scrapper script for documentation generated by React Styleguidist