<commit_before># React Styleguidist

[![Build Status](https://travis-ci.org/styleguidist/react-styleguidist.svg)](https://travis-ci.org/styleguidist/react-styleguidist)
[![npm](https://img.shields.io/npm/v/react-styleguidist.svg)](https://www.npmjs.com/package/react-styleguidist)
[![Join the chat at https://gitter.im/styleguidist/styleguidist](https://badges.gitter.im/styleguidist/styleguidist.svg)](https://gitter.im/styleguidist/styleguidist?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Codecov](https://codecov.io/gh/styleguidist/react-styleguidist/branch/master/graph/badge.svg)](https://codecov.io/gh/styleguidist/react-styleguidist)

**Style guide — documentation — component workbench**

React Styleguidist is a style guide generator for React components. It lists component `propTypes` and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server. Check out [**the demo style guide**](http://react-styleguidist.js.org/).

![](https://d3vv6lp55qjaqc.cloudfront.net/items/271B372x102S0c052i3F/react-styleguidist7.gif)

## Usage

* **[Getting Started](./GettingStarted.md): install and run Styleguidist**
* [Locating components](./Components.md): point Styleguidist to your React components
* [Configuring webpack](./Webpack.md): tell Styleguidist how to load your code
* [Cookbook](./Cookbook.md): how to solve common tasks with Styleguidist

## Examples

* [Basic style guide](http://react-styleguidist.js.org), [source](./examples/basic)
* Style guide with sections, [source](./examples/sections)
* Style guide with customized styles, [source](./examples/customised)
* Style guide with custom express endpoints, [source](./examples/express)
* create-react-app integration, [source](./examples/cra)

## Showcase

Real projects using React Styleguidist:

* [Rumble Charts](https://rumble-charts.github.io/rumble-charts/)
* [better-react-spinkit](http://better-react-spinkit.benjamintatum.com/)
* [Semantic UI Components for React](http://hallister.github.io/semantic-react/)
* [Dialog Components](https://dialogs.github.io/dialog-web-components/)
* [Bulma Components](http://bokuweb.github.io/re-bulma/)
* [More projects…](https://github.com/styleguidist/react-styleguidist/issues/127)

## Integration with other tools

* create-react-app — just works, see the [Getting Started](docs/GettingStarted.md) guide!
* [TypeScript](https://github.com/pvasek/react-docgen-typescript)
* [SourceJS](https://github.com/sourcejs/sourcejs-react-styleguidist)

## Resources

* [Building React Components Library](https://skillsmatter.com/skillscasts/8140-building-react-components-library) talk by [<NAME>](https://github.com/operatino)
* [Interview with <NAME>](http://survivejs.com/blog/styleguidist-interview/) about React Styleguidist.

## Advanced documentation

* [Configuration](./Configuration.md)
* [CLI commands and options](./CLI.md)
* [Node API](./API.md)
* [FAQ](./FAQ.md)

## Change log

The change log can be found on the [Releases page](https://github.com/styleguidist/react-styleguidist/releases).

## Contributing

Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).

## Authors and license

[<NAME>](http://sapegin.me) and [contributors](https://github.com/styleguidist/react-styleguidist/graphs/contributors).

MIT License, see the included [License.md](License.md) file.
<commit_msg>Docs: Fix readme links (#321)<commit_after># React Styleguidist

[![Build Status](https://travis-ci.org/styleguidist/react-styleguidist.svg)](https://travis-ci.org/styleguidist/react-styleguidist)
[![npm](https://img.shields.io/npm/v/react-styleguidist.svg)](https://www.npmjs.com/package/react-styleguidist)
[![Join the chat at https://gitter.im/styleguidist/styleguidist](https://badges.gitter.im/styleguidist/styleguidist.svg)](https://gitter.im/styleguidist/styleguidist?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Codecov](https://codecov.io/gh/styleguidist/react-styleguidist/branch/master/graph/badge.svg)](https://codecov.io/gh/styleguidist/react-styleguidist)

**Style guide — documentation — component workbench**

React Styleguidist is a style guide generator for React components. It lists component `propTypes` and shows live, editable usage examples based on Markdown files. You can use it to generate a static HTML page to share and publish or as a workbench for developing new components using hot reloaded dev server. Check out [**the demo style guide**](http://react-styleguidist.js.org/).

![](https://d3vv6lp55qjaqc.cloudfront.net/items/271B372x102S0c052i3F/react-styleguidist7.gif)

## Usage

* **[Getting Started](./docs/GettingStarted.md): install and run Styleguidist**
* [Locating components](./docs/Components.md): point Styleguidist to your React components
* [Configuring webpack](./docs/Webpack.md): tell Styleguidist how to load your code
* [Cookbook](./docs/Cookbook.md): how to solve common tasks with Styleguidist

## Examples

* [Basic style guide](http://react-styleguidist.js.org), [source](./examples/basic)
* Style guide with sections, [source](./examples/sections)
* Style guide with customized styles, [source](./examples/customised)
* Style guide with custom express endpoints, [source](./examples/express)
* create-react-app integration, [source](./examples/cra)

## Showcase

Real projects using React Styleguidist:

* [Rumble Charts](https://rumble-charts.github.io/rumble-charts/)
* [better-react-spinkit](http://better-react-spinkit.benjamintatum.com/)
* [Semantic UI Components for React](http://hallister.github.io/semantic-react/)
* [Dialog Components](https://dialogs.github.io/dialog-web-components/)
* [Bulma Components](http://bokuweb.github.io/re-bulma/)
* [More projects…](https://github.com/styleguidist/react-styleguidist/issues/127)

## Integration with other tools

* create-react-app — just works, see the [Getting Started](docs/GettingStarted.md) guide!
* [TypeScript](https://github.com/pvasek/react-docgen-typescript)
* [SourceJS](https://github.com/sourcejs/sourcejs-react-styleguidist)

## Resources

* [Building React Components Library](https://skillsmatter.com/skillscasts/8140-building-react-components-library) talk by [<NAME>](https://github.com/operatino)
* [Interview with Artem Sapegin](http://survivejs.com/blog/styleguidist-interview/) about React Styleguidist.

## Advanced documentation

* [Configuration](./docs/Configuration.md)
* [CLI commands and options](./docs/CLI.md)
* [Node API](./docs/API.md)
* [FAQ](./docs/FAQ.md)

## Change log

The change log can be found on the [Releases page](https://github.com/styleguidist/react-styleguidist/releases).

## Contributing

Everyone is welcome to contribute. Please take a moment to review the [contributing guidelines](Contributing.md).

## Authors and license

[<NAME>](http://sapegin.me) and [contributors](https://github.com/styleguidist/react-styleguidist/graphs/contributors).

MIT License, see the included [License.md](License.md) file.

{'fraction_non_alphanumeric': 0.15023080151070078, 'fraction_numerical': 0.007693383690026577, 'mean_word_length': 5.583793738489871, 'pattern_counts': {'":': 0, '<': 8, '<?xml version=': 0, '>': 8, 'https://': 38, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '586652', 'n_tokens_mistral': 2357, 'n_tokens_neox': 2318, 'n_words': 473}