Style guide — documentation — component workbench

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.

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

• 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

Real projects using React Styleguidist:

• Rumble Charts
• better-react-spinkit
• Semantic UI Components for React
• Dialog Components
• Bulma Components
• More projects…

• create-react-app — just works, see the Getting Started guide!
• TypeScript
• SourceJS

• Building React Components Library talk by Robert Haritonov
• Interview with Artem Sapegin about React Styleguidist.

• Configuration
• CLI commands and options
• Node API
• FAQ

The change log can be found on the Releases page.

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

Artem Sapegin and contributors.

MIT License, see the included License.md file.