Skip to content
Isolated React component development environment with a living style guide
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Chore: Add Sponsor GitHub button Jun 7, 2019
docs Docs: Add example of using Context (#1411) Aug 8, 2019
examples Docs: Fix "React.useState is not a function" error in the basic examp… Aug 15, 2019
flow-typed Fix: Replace 'walkes' with 'estree-walker' (#1349) Jun 19, 2019
src Fix: Single sections can contain only sections (#1414) Aug 8, 2019
templates Choer: Babelify everything (#1105) Aug 26, 2018
test Test: Add more Cypress tests for isolated mode toggling (#1304) Jun 16, 2019
.editorconfig Chore: Update dotfiles Jun 17, 2017
.eslintignore Fix: Fix imports false positives (#1130) Sep 11, 2018
.eslintrc Test: Fix tests and lint warnings Nov 7, 2018
.flowconfig Chore: Fix Flow Sep 3, 2018
.gitignore Chore: Add a comment how to analyze webpack bundle Nov 8, 2018
.npmignore Chore: Do not publish tests to npm Feb 8, 2017
.nvmrc Chore: Update nvmrc to use node 8 (#552) Jul 29, 2017
.prettierignore Fix: Fix imports false positives (#1130) Sep 11, 2018
.prettierrc Chore: Add Prettier for .md files (#709) Dec 6, 2017
.travis.yml Chore: Tweak Travis config May 3, 2019
License.md Chore: Add Prettier for .md files (#709) Dec 6, 2017
Readme.md Chore: Update linters Jul 7, 2018
babel.config.js Fix: Upgrade deps Mar 26, 2019
cypress.json Test: Fix integration tests Aug 6, 2018
dangerfile.js Chore: Make warning about package-lock.json more clear Apr 5, 2018
jsconfig.json Chore: Add jsconfig Dec 19, 2017
package-lock.json Chore: Upgrade react-icons to 3.7.0 (#1406) Jul 25, 2019
package.json Chore: Upgrade react-icons to 3.7.0 (#1406) Jul 25, 2019
styleguide.config.js Choer: Babelify everything (#1105) Aug 26, 2018

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.