<div align="center" markdown="1">

<img src="https://d3vv6lp55qjaqc.cloudfront.net/items/061f0A2n1B0H3p0T1p1f/react-styleguidist-logo.png" alt="React Styleguidist" width="400">

**MODIFIED VERSION**

This is modified version of the original React Styleguidist.

</div>

### Read below before use
- this repo will not be maintained
- no support will be provided
- no documentation updates for new features
- there can be lots of issues with different configurations as I only made this to work for my own needs
- use on your own responsibility

# Deviations from original styleguidist package
- changes in babel configuration to fix MobX observables
- groups support `( see screenshots and ./examples/basic/styleguide.config.js )`
- add extra comments column for special md comment blocks `usage: "> header" and ">> text" in MD files`
- inject custom scss file to modify styles `( customScss: './examples/basic/custom.scss' )`
- auto generate navigation headings by reading md headings ( ## Test -> will create Test in navigation )

![](https://i.imgur.com/Ifof2of.png)
![](https://i.imgur.com/bL0lsVz.png)
![](https://i.imgur.com/G8EboqS.png)

# Change Log

All notable changes to this project will be documented in this file.

> **[ 1.2.* ]** - 10 - Jan - 2018
- styling changes

> **[ 1.2.4 ]** - 9 - Jan - 2018
- headings
  - **improvements**
    - headings will use pure scss
  - **new features**
    - add type support, component heading will have extra class now `heading--type-component`



---------- Original styleguidist readme ----------

## Usage

* **[Getting Started](https://react-styleguidist.js.org/docs/getting-started.html): install and run Styleguidist**
* [Documenting components](https://react-styleguidist.js.org/docs/documenting.html): how to write documentation
* [Locating components](https://react-styleguidist.js.org/docs/components.html): point Styleguidist to your React components
* [Configuring webpack](https://react-styleguidist.js.org/docs/webpack.html): tell Styleguidist how to load your code
* [Cookbook](https://react-styleguidist.js.org/docs/cookbook.html): how to solve common tasks with Styleguidist

## Examples

* [Basic style guide](https://react-styleguidist.js.org/examples/basic/), [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](https://hallister.github.io/semantic-react/)
* [Dialog Components](https://dialogs.github.io/dialog-web-components/)
* [Bulma Components](https://bokuweb.github.io/re-bulma/)
* [Yammer Components](https://microsoft.github.io/YamUI/)
* [More projects…](https://github.com/styleguidist/react-styleguidist/issues/127)

## Integration with other tools

* Create React App — just works, see the [Getting Started](https://react-styleguidist.js.org/docs/getting-started.html) guide!
* Create React App + TypeScript, see [Configuring webpack](https://react-styleguidist.js.org/docs/webpack.html)
* TypeScript, see [react-docgen-typescript](https://github.com/styleguidist/react-docgen-typescript)

## Third-party tools

* [snapguidist](https://github.com/styleguidist/snapguidist): snapshot testing for React Styleguidist
* [react-styleguidist-visual](https://github.com/unindented/react-styleguidist-visual): automated visual testing for React Styleguidist, using Puppeteer and pixelmatch
* [styleguidist-scrapper](https://github.com/livechat/styleguidist-scrapper): scrapper script for documentation generated by React Styleguidist

## Resources

* [The Dream of Styleguide Driven Development](https://www.youtube.com/watch?v=JjXnmhNW8Cs) talk by [Sara Vieira](https://github.com/saravieira)
* [Building React Components Library](https://skillsmatter.com/skillscasts/8140-building-react-components-library) talk by [Robert Haritonov](https://github.com/operatino)
* [Say Cheese: Snapshots and Visual Testing](https://developers.livechatinc.com/blog/snapshots-visual-testing/)
* [Interview with Artem Sapegin](https://survivejs.com/blog/styleguidist-interview/) about React Styleguidist.

## Advanced documentation

* [Configuration](https://react-styleguidist.js.org/docs/configuration.html)
* [CLI commands and options](https://react-styleguidist.js.org/docs/cli.html)
* [Node.js API](https://react-styleguidist.js.org/docs/api.html)

## 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 read the [contributing guidelines](.github/Contributing.md) and the [developer guide](https://react-styleguidist.js.org/docs/development.html).

## Authors and license

[Artem Sapegin](http://sapegin.me) and [contributors](https://github.com/styleguidist/react-styleguidist/graphs/contributors).

Logo by [Sara Vieira](https://github.com/SaraVieira) and [Andrey Okonetchnikov](https://github.com/okonet).

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