React components style guide generator
Package: react-styleguidist
Created by: styleguidist
Last modified: Fri, 19 Jan 2024 12:00:22 GMT
Version: 13.1.2
License: MIT
Downloads: 306,277
Repository: https://github.com/styleguidist/react-styleguidist
Install
npm install react-styleguidist
yarn add react-styleguidist
Isolated React component development environment with a living style guide
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
- Getting Started: install and run Styleguidist
- Documenting components: how to write documentation
- Locating components: point Styleguidist to your React components
- Configuring webpack: tell Styleguidist how to load your code
- Cookbook: how to solve common tasks with Styleguidist
Advanced documentation
Examples
- Basic style guide, source
- Style guide with sections, source
- Style guide with customized styles, source
- Style guide with custom express endpoints, source
- Create React App integration, source
Showcase
Real projects using React Styleguidist:
- Rumble Charts
- better-react-spinkit
- Semantic UI Components for React
- Dialog Components
- Bulma Components
- Yammer Components
- More projects…
Integration with other tools
- Create React App — supported out of the box, see the Getting Started guide
- Vue, see Vue Styleguidist
Third-party tools
- snapguidist: snapshot testing for React Styleguidist
- react-styleguidist-visual: automated visual testing for React Styleguidist, using Puppeteer and pixelmatch
- styleguidist-scrapper: scrapper script for documentation generated by React Styleguidist
Resources
- The Dream of Styleguide Driven Development talk by Sara Vieira
- Building React Components Library talk by Robert Haritonov
- Say Cheese: Snapshots and Visual Testing
- Interview with Artem Sapegin about React Styleguidist.
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.
Dependencies
@tippyjs/react: 4.1.0@types/react-test-renderer: ^18.0.0@vxna/mini-html-webpack-template: ^2.0.0acorn: ^6.4.1acorn-jsx: ^5.1.0assert: 1.5.0ast-types: ~0.14.2buble: 0.20.0clean-webpack-plugin: ^4.0.0clipboard-copy: ^3.1.0clsx: ^1.0.4common-dir: ^3.0.0copy-webpack-plugin: ^11.0.0core-js: ^3.6.4doctrine: ^3.0.0es6-object-assign: ~1.1.0es6-promise: ^4.2.8escape-string-regexp: ^1.0.5escodegen: ^1.12.0estree-walker: ~0.9.0fastest-levenshtein: ^1.0.9findup: ^0.1.5function.name-polyfill: ^1.0.6github-slugger: ^1.2.1glob: ^7.1.5glogg: ^1.0.2hash-sum: ^2.0.0is-plain-obj: ^1.1.0javascript-stringify: ^2.0.0jss: ^10.9.0jss-plugin-camel-case: ^10.9.0jss-plugin-compose: ^10.9.0jss-plugin-default-unit: ^10.9.0jss-plugin-global: ^10.9.0jss-plugin-isolate: ^10.9.0jss-plugin-nested: ^10.9.0kleur: ^3.0.3listify: ^1.0.0lodash: ^4.17.15lowercase-keys: ^2.0.0markdown-to-jsx: ^6.11.4mini-html-webpack-plugin: ^3.1.3mri: ^1.1.4ora: ^4.0.2prismjs: ^1.17.1prop-types: ^15.8.1q-i: ^2.0.1qss: ^2.0.3react-dev-utils: ^12.0.0react-docgen: ^5.0.0react-docgen-annotation-resolver: ^2.0.0react-docgen-displayname-handler: ^3.0.0react-group: ^3.0.2react-icons: ^3.8.0react-simple-code-editor: ^0.13.1recast: ~0.18.5remark: ^13.0.0strip-html-comments: ^1.0.0terser-webpack-plugin: ^5.3.3to-ast: ^1.0.0type-detect: ^4.0.8unist-util-visit: ^2.0.0webpack-dev-server: ^4.9.2webpack-merge: ^4.2.2
Dependencies
@babel/cli: ^7.8.4@babel/core: ^7.9.0@babel/plugin-proposal-class-properties: ^7.8.3@babel/preset-env: ^7.9.0@babel/preset-flow: ^7.9.0@babel/preset-react: ^7.18.6@babel/preset-typescript: ^7.18.6@testing-library/jest-dom: ^5.11.4@testing-library/react: ^13.4.0@types/buble: ^0.19.2@types/copy-webpack-plugin: ^5.0.2@types/doctrine: 0.0.3@types/escodegen: 0.0.6@types/estree: ^0.0.39@types/hash-sum: ^1.0.0@types/jest: ^26.0.14@types/keymirror: ^0.1.1@types/lodash: ^4.14.144@types/markdown-to-jsx: ^6.9.0@types/node: ^12.12.3@types/prismjs: ^1.16.0@types/react: ^18.0.28@types/react-dom: ^18.0.10@types/terser-webpack-plugin: ^2.2.3@types/type-detect: ^4.0.1@types/webpack: ^5.28.0@types/webpack-dev-server: ^3.11.1@types/webpack-env: ^1.14.1@typescript-eslint/eslint-plugin: ^4.4.1@typescript-eslint/parser: ^4.4.1babel-core: ^7.0.0-bridge.0babel-eslint: ^10.1.0babel-jest: ^26.6.0babel-loader: ^8.1.0css-loader: ^6.7.1danger: ^10.5.3deabsdeep: ^1.0.6deepfreeze: ^2.0.0dog-names: ^2.0.0eslint: ^7.11.0eslint-config-tamia: ^7.2.6eslint-import-resolver-typescript: ^2.3.0eslint-plugin-compat: ^3.8.0eslint-plugin-import: ^2.22.1eslint-plugin-jsx-a11y: ^6.3.1eslint-plugin-react: ^7.21.4file-loader: ^6.2.0fs-extra: ^9.0.0husky: ^4.3.0jest: ^26.6.0keymirror: ^0.1.1lint-staged: ^10.5.1memfs: ~2.15.5prettier: 2.1.2raf: ^3.4.1react: ^18.2.0react-dom: ^18.2.0react-test-renderer: ^18.2.0strip-shebang: ^1.0.2style-loader: ^3.3.1typescript: ^4.7.4url-loader: ^4.1.1webpack: ^5.72.0webpack-cli: ^4.9.2
