**Isolated React component development environment with a living style guide** [![npm](https://img.shields.io/npm/v/react-styleguidist.svg)](https://www.npmjs.com/package/react-styleguidist) [![CI status](https://github.com/styleguidist/react-styleguidist/workflows/CI/badge.svg)](https://github.com/styleguidist/react-styleguidist.git/actions) [![Codecov](https://codecov.io/gh/styleguidist/react-styleguidist/branch/master/graph/badge.svg)](https://codecov.io/gh/styleguidist/react-styleguidist) [![Join the chat at https://gitter.im/styleguidist/styleguidist](https://badges.gitter.im/styleguidist/styleguidist.svg)](https://gitter.im/styleguidist/styleguidist?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) ![Discord](https://img.shields.io/discord/842832186914635806?logo=discord) [![Open Source Helpers](https://www.codetriage.com/styleguidist/react-styleguidist/badges/users.svg)](https://www.codetriage.com/styleguidist/react-styleguidist)

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**](https://react-styleguidist.js.org/examples/basic/). ![React Styleguidist in action](https://user-images.githubusercontent.com/1703219/74945569-51c6ad00-543b-11ea-8351-f4d86860893a.gif) ## Usage - **[Getting Started](https://react-styleguidist.js.org/docs/getting-started): install and run Styleguidist** - [Documenting components](https://react-styleguidist.js.org/docs/documenting): how to write documentation - [Locating components](https://react-styleguidist.js.org/docs/components): point Styleguidist to your React components - [Configuring webpack](https://react-styleguidist.js.org/docs/webpack): tell Styleguidist how to load your code - [Cookbook](https://react-styleguidist.js.org/docs/cookbook): how to solve common tasks with Styleguidist ## Advanced documentation - [Configuration](https://react-styleguidist.js.org/docs/configuration) - [CLI commands and options](https://react-styleguidist.js.org/docs/cli) - [Node.js API](https://react-styleguidist.js.org/docs/api) ## Examples - [Basic style guide](https://react-styleguidist.js.org/examples/basic/), [source](./examples/basic) - Style guide with sections, [source](./examples/sections) - Style guide with customized styles, [source](./examples/customised) - Style guide with custom express endpoints, [source](./examples/express) - Create React App integration, [source](./examples/cra) ## Showcase Real projects using React Styleguidist: - [Rumble Charts](https://rumble-charts.github.io/rumble-charts/) - [better-react-spinkit](http://better-react-spinkit.benjamintatum.com/) - [Semantic UI Components for React](https://hallister.github.io/semantic-react/) - [Dialog Components](https://dialogs.github.io/dialog-web-components/) - [Bulma Components](https://bokuweb.github.io/re-bulma/) - [Yammer Components](https://microsoft.github.io/YamUI/) - [More projects…](https://github.com/styleguidist/react-styleguidist/issues/127) ## Integration with other tools - Create React App — supported out of the box, see the [Getting Started](https://react-styleguidist.js.org/docs/getting-started) guide - Vue, see [Vue Styleguidist](https://github.com/vue-styleguidist/vue-styleguidist) ## Third-party tools - [snapguidist](https://github.com/styleguidist/snapguidist): snapshot testing for React Styleguidist - [react-styleguidist-visual](https://github.com/unindented/react-styleguidist-visual): automated visual testing for React Styleguidist, using Puppeteer and pixelmatch - [styleguidist-scrapper](https://github.com/livechat/styleguidist-scrapper): scrapper script for documentation generated by React Styleguidist ## Resources - [The Dream of Styleguide Driven Development](https://www.youtube.com/watch?v=JjXnmhNW8Cs) talk by [Sara Vieira](https://github.com/saravieira) - [Building React Components Library](https://skillsmatter.com/skillscasts/8140-building-react-components-library) talk by [Robert Haritonov](https://github.com/operatino) - [Say Cheese: Snapshots and Visual Testing](https://developers.livechatinc.com/blog/snapshots-visual-testing/) - [Interview with Artem Sapegin](https://survivejs.com/blog/styleguidist-interview/) about React Styleguidist. ## Change log The change log can be found on the [Releases page](https://github.com/styleguidist/react-styleguidist/releases). ## Contributing Everyone is welcome to contribute. Please take a moment to read the [contributing guidelines](.github/Contributing.md) and the [developer guide](https://react-styleguidist.js.org/docs/development). ## Sponsoring [Become a sponsor](https://opencollective.com/styleguidist#sponsor) and get your logo on our Readme on GitHub with a link to your site.

[Become a backer](https://opencollective.com/styleguidist#backer) get your image on our Readme on GitHub with a link to your site.

## Authors and license [Artem Sapegin](http://sapegin.me) and [contributors](https://github.com/styleguidist/react-styleguidist/graphs/contributors). Logo by [Sara Vieira](https://github.com/SaraVieira) and [Andrey Okonetchnikov](https://github.com/okonet). MIT License, see the included [License.md](License.md) file.

	Stars	Issues	Version	Updated	Created
@compodoc/compodoc			1.1.24	5 days ago	7 years ago
@storybook/cli	82,827	1,857	8.0.9	6 days ago	7 years ago
react-cosmos			6.1.1	2 months ago	8 years ago
react-styleguidist	10,790	237	13.1.2	3 months ago	9 years ago

@compodoc/compodoc vs @storybook/cli vs react-cosmos vs react-styleguidist

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past