Isolated React component development environment with a living style guide
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Chore: Update linters Jul 7, 2018
bin Chore: Chalk → Kleur Aug 8, 2018
docs Docs: Correct cookbook dynamically load other components (#1081) Aug 8, 2018
examples Fix: Fix preview of method optional argument, JSDoc param and return … Aug 13, 2018
loaders Fix: Fix preview of method optional argument, JSDoc param and return … Aug 13, 2018
scripts Chore: Chalk → Kleur Aug 8, 2018
src Fix: Make slot components overridable (#1087) Aug 14, 2018
test fix: Cypress failing test (#1077) Aug 7, 2018
.babelrc Chore: Replace System.import with import (#901) Mar 29, 2018
.editorconfig Chore: Update dotfiles Jun 17, 2017
.eslintignore Test: Fix failing tests Mar 2, 2017
.eslintrc Chore: Remove unnecessary ESLint rules Apr 5, 2018
.gitignore Chore: Move Cypress folder inside test (#865) Mar 12, 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 Chore: Don't prettify build artifacts Mar 21, 2018
.prettierrc Chore: Add Prettier for .md files (#709) Dec 6, 2017
.travis.yml Chore: Expand Travis matrix to use Webpack v3 and v4 (#904) Mar 31, 2018
License.md Chore: Add Prettier for .md files (#709) Dec 6, 2017
Readme.md Chore: Update linters Jul 7, 2018
browserslist Chore: babel-preset-es2015 → babel-preset-env, add eslint-plugin-compat Mar 10, 2017
cypress.json Chore: Update Cypress config for a new version May 31, 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: Update vulnerable package url-parse Aug 16, 2018
package.json Chore: Chalk → Kleur Aug 8, 2018
styleguide.config.js Docs: Style guide for Styleguidist UI - issue #897 (#926) Apr 10, 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.