<commit_before># React Styleguidist Integration Plugin for SourceJS

[![Build Status](https://travis-ci.org/sourcejs/sourcejs-react-styleguidist.svg?branch=master)](https://travis-ci.org/sourcejs/sourcejs-react-styleguidist)

Fork of React Style Guide generator [react-styleguidist](https://github.com/sapegin/react-styleguidist) with integration to [SourceJS](http://sourcejs.com) platform.

[Original styleguidist example](http://sapegin.github.io/react-styleguidist/).
(example with SourceJS will be available later)

![](https://s3.amazonaws.com/f.cl.ly/items/3i0E1D1L1c1m1s2G1d0y/Screen%20Recording%202015-09-24%20at%2009.49%20AM.gif)

To add automatically generated React props docs use [sourcejs-react-docgen](https://github.com/sourcejs/sourcejs-react-docgen) plugin. Check [SourceJS React bundle example](http://github.com/sourcejs/react-styleguidist-example) for more insights.

## Installation

```
cd sourcejs-project
npm install sourcejs-react-styleguidist --save
```

Add custom markdown renderer conf into SourceJS `options.js` file:

```javascript
module.exports = {
	core: {
        processMd: {
            languageRenderers: {
                jsx: require('sourcejs-react-styleguidist/core/lang-jsx').processExample
            }
        }
    }
};
```

After re-running your SourceJS app, plugin will be loaded automatically.

### Important configs

Configure path to components in SourceJS `options.js` file:

```javascript<commit_msg>update link to example bundle<commit_after># React Styleguidist Integration Plugin for SourceJS

[![Build Status](https://travis-ci.org/sourcejs/sourcejs-react-styleguidist.svg?branch=master)](https://travis-ci.org/sourcejs/sourcejs-react-styleguidist)

Fork of React Style Guide generator [react-styleguidist](https://github.com/sapegin/react-styleguidist) with integration to [SourceJS](http://sourcejs.com) platform.

[Original styleguidist example](http://sapegin.github.io/react-styleguidist/).
(example with SourceJS will be available later)

![](https://s3.amazonaws.com/f.cl.ly/items/3i0E1D1L1c1m1s2G1d0y/Screen%20Recording%202015-09-24%20at%2009.49%20AM.gif)

To add automatically generated React props docs use [sourcejs-react-docgen](https://github.com/sourcejs/sourcejs-react-docgen) plugin. Check [SourceJS React bundle example](http://github.com/sourcejs/sourcejs-react-bundle-example) for more insights.

## Installation

```
cd sourcejs-project
npm install sourcejs-react-styleguidist --save
```

Add custom markdown renderer conf into SourceJS `options.js` file:

```javascript
module.exports = {
	core: {
        processMd: {
            languageRenderers: {
                jsx: require('sourcejs-react-styleguidist/core/lang-jsx').processExample
            }
        }
    }
};
```

After re-running your SourceJS app, plugin will be loaded automatically.

### Important configs

Configure path to components in SourceJS `options.js` file:

```javascript
{'fraction_non_alphanumeric': 0.12589559877175024, 'fraction_numerical': 0.022517911975435005, 'mean_word_length': 4.470149253731344, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, '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': '7261684', 'n_tokens_mistral': 956, 'n_tokens_neox': 932, 'n_words': 191}