Skip to content
Isolated React component development environment with a living style guide
TypeScript JavaScript
Branch: master
Clone or download

Latest commit

b2whats and Vladimir Akimov Fix: Show examples with targetIndex = 0 (#1573)
Co-authored-by: Vladimir Akimov <vmakimov@avito.ru>
Latest commit b4c2845 May 5, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Docs: Clean up language in first two paragraphs (#1432) Sep 17, 2019
docs Docs: Update styled-components usage May 5, 2020
examples Build(deps): Bump acorn from 6.3.0 to 6.4.1 in /examples/customised (#… Mar 14, 2020
src Fix: Show examples with targetIndex = 0 (#1573) May 6, 2020
templates Choer: Babelify everything (#1105) Aug 26, 2018
test Refactor: Rewrite loaders folder in typescript (#1485) Dec 4, 2019
.editorconfig Chore: Update dotfiles Jun 17, 2017
.eslintignore Fix: Exported TypeScript typings (#1550) Mar 11, 2020
.eslintrc Chore: Remove remnants of Flow (#1549) Mar 10, 2020
.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 Breaking: Drop Node.js 8 support (#1545) Mar 5, 2020
.prettierignore Chore: Remove remnants of Flow (#1549) Mar 10, 2020
.prettierrc Chore: Add Prettier for .md files (#709) Dec 6, 2017
.travis.yml Chore: Remove remnants of Flow (#1549) Mar 10, 2020
License.md Chore: Add Prettier for .md files (#709) Dec 6, 2017
Readme.md Merge remote-tracking branch 'origin/master' into 11 Feb 28, 2020
babel.config.js Fix: Exported TypeScript typings (#1550) Mar 11, 2020
cypress.json Test: Fix integration tests Aug 6, 2018
dangerfile.js Chore: Make warning about package-lock.json more clear Apr 5, 2018
package-lock.json chore: Upgrade deps Mar 29, 2020
package.json chore: Upgrade deps Mar 29, 2020
release.config.js Build: Use semantic-release with ESLint preset (#1459) Oct 31, 2019
styleguide.config.js Choer: Babelify everything (#1105) Aug 26, 2018
tsconfig.json Refactor: Rewrite loaders folder in typescript (#1485) Dec 4, 2019
tsconfig.types.json Refactor: Rewrite loaders folder in typescript (#1485) Dec 4, 2019

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.

React Styleguidist in action

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.

Buy Me A Coffee

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.