react-styleguidist

WebJar for react-styleguidist

License	MIT
Categories	GUI User Interface React Web Frameworks
GroupId	org.webjars.npm
ArtifactId	react-styleguidist
Last Version	9.0.5
Release Date	Mar 27, 2019
Type	jar
Description	react-styleguidist WebJar for react-styleguidist
Project URL	http://webjars.org
Source Code Management	https://github.com/styleguidist/react-styleguidist

Download react-styleguidist

Filename	Size
react-styleguidist-9.0.5.pom
react-styleguidist-9.0.5.jar	157 KB
react-styleguidist-9.0.5-sources.jar	22 bytes
react-styleguidist-9.0.5-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/react-styleguidist/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>react-styleguidist</artifactId>
    <version>9.0.5</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/react-styleguidist/
implementation 'org.webjars.npm:react-styleguidist:9.0.5'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/react-styleguidist/
implementation ("org.webjars.npm:react-styleguidist:9.0.5")

Apache Buildr

'org.webjars.npm:react-styleguidist:jar:9.0.5'

Apache Ivy

<dependency org="org.webjars.npm" name="react-styleguidist" rev="9.0.5">
  <artifact name="react-styleguidist" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='react-styleguidist', version='9.0.5')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "react-styleguidist" % "9.0.5"

Leiningen

[org.webjars.npm/react-styleguidist "9.0.5"]

Dependencies

compile (61)

Group / Artifact	Type	Version
org.webjars.npm : jss-isolate	jar	[5.1.0,6)
org.webjars.npm : type-detect	jar	[4.0.8,5)
org.webjars.npm : unist-util-visit	jar	[1.4.0,2)
org.webjars.npm : clipboard-copy	jar	[3.0.0,4)
org.webjars.npm : qss	jar	[2.0.3,3)
org.webjars.npm : jss-default-unit	jar	[8.0.2,9)
org.webjars.npm : lowercase-keys	jar	[1.0.1,2)
org.webjars.npm : es6-object-assign	jar	[1.1.0,1.2)
org.webjars.npm : listify	jar	[1.0.0,2)
org.webjars.npm : remark	jar	[10.0.1,11)
org.webjars.npm : webpack-dev-server	jar	[3.2.1,4)
org.webjars.npm : github-slugger	jar	[1.2.1,2)
org.webjars.npm : react-docgen-displayname-handler	jar	[2.1.1,3)
org.webjars.npm : doctrine	jar	[3.0.0,4)
org.webjars.npm : react-simple-code-editor	jar	[0.9.7,0.10)
org.webjars.npm : markdown-to-jsx	jar	[6.9.3,7)
org.webjars.npm : rewrite-imports	jar	[1.2.0]
org.webjars.npm : ast-types	jar	[0.12.2,0.13)
org.webjars.npm : walkes	jar	[0.2.1,0.3)
org.webjars.npm : clean-webpack-plugin	jar	[1.0.1,2)
org.webjars.npm : acorn-jsx	jar	[5.0.1,6)
org.webjars.npm : terser-webpack-plugin	jar	[1.2.3,2)
org.webjars.npm : glogg	jar	[1.0.2,2)
org.webjars.npm : kleur	jar	[3.0.2,4)
org.webjars.npm : jss-compose	jar	[5.0.0,6)
org.webjars.npm : leven	jar	[2.1.0,3)
org.webjars.npm : core-js	jar	[3.0.0,4)
org.webjars.npm : react-icons	jar	[2.2.7,3)
org.webjars.npm : react-dev-utils	jar	[6.1.1,7)
org.webjars.npm : lodash	jar	[4.17.11,5)
org.webjars.npm : vxna__mini-html-webpack-template	jar	[0.1.7,0.2)
org.webjars.npm : function.name-polyfill	jar	[1.0.6,2)
org.webjars.npm : es6-promise	jar	[4.2.6,5)
org.webjars.npm : jss-camel-case	jar	[6.1.0,7)
org.webjars.npm : react-group	jar	[3.0.0,4)
org.webjars.npm : escodegen	jar	[1.11.1,2)
org.webjars.npm : acorn	jar	[6.1.1,7)
org.webjars.npm : findup	jar	[0.1.5,0.2)
org.webjars.npm : recast	jar	[0.17.4,0.18)
org.webjars.npm : mri	jar	[1.1.4,2)
org.webjars.npm : to-ast	jar	[1.0.0,2)
org.webjars.npm : glob	jar	[7.1.3,8)
org.webjars.npm : buble	jar	[0.19.7]
org.webjars.npm : webpack-merge	jar	[4.2.1,5)
org.webjars.npm : is-directory	jar	[0.3.1,0.4)
org.webjars.npm : copy-webpack-plugin	jar	[4.6.0,5)
org.webjars.npm : ora	jar	[3.2.0,4)
org.webjars.npm : mini-html-webpack-plugin	jar	[0.2.3,0.3)
org.webjars.npm : loader-utils	jar	[1.2.3,2)
org.webjars.npm : react-docgen	jar	[3.0.0-rc.2]
org.webjars.npm : jss	jar	[9.8.7,10)
org.webjars.npm : q-i	jar	[2.0.1,3)
org.webjars.npm : javascript-stringify	jar	[1.6.0,2)
org.webjars.npm : jss-nested	jar	[6.0.1,7)
org.webjars.npm : prismjs	jar	[1.16.0,2)
org.webjars.npm : react-lifecycles-compat	jar	[3.0.4,4)
org.webjars.npm : react-docgen-annotation-resolver	jar	[1.0.0,2)
org.webjars.npm : prop-types	jar	[15.7.2,16)
org.webjars.npm : jss-global	jar	[3.0.0,4)
org.webjars.npm : clsx	jar	[1.0.3,2)
org.webjars.npm : common-dir	jar	[2.0.2,3)

Project Modules

There are no modules declared in this project.

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

• Configuration
• CLI commands and options
• Node.js API

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.

Styleguidist

React style guide generator

Versions

Version
9.0.5 Mar 27, 2019