Skip to content
Isolated React component development environment with a living style guide
JavaScript
Branch: master
Clone or download
Pull request Compare This branch is 2 commits ahead, 44 commits behind styleguidist:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
examples
flow-typed
src
templates
test
.editorconfig
.eslintignore
.eslintrc
.flowconfig
.gitignore
.npmignore
.nvmrc
.prettierignore
.prettierrc
.travis.yml
License.md
Readme.md
babel.config.js
cypress.json
dangerfile.js
jsconfig.json
package-lock.json
package.json
styleguide.config.js

Readme.md

React Styleguidist

Isolated React component development environment with a living style guide

Build Status npm Join the chat at https://gitter.im/styleguidist/styleguidist Codecov Open Source Helpers

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

Advanced documentation

Examples

Showcase

Real projects using React Styleguidist:

Integration with other tools

Third-party tools

Resources

Change log

The change log can be found on the Releases page.

Contributing

Everyone is welcome to contribute. Please take a moment to read the contributing guidelines and the developer guide.

Sponsoring

Become a sponsor and get your logo on our Readme on GitHub with a link to your site.

Become a backer get your image on our Readme on GitHub with a link to your site.

Authors and license

Artem Sapegin and contributors.

Logo by Sara Vieira and Andrey Okonetchnikov.

MIT License, see the included License.md file.

You can’t perform that action at this time.