<commit_before># Woo
[![Build Status](https://travis-ci.org/adorableio/woo.svg?branch=master)](https://travis-ci.org/adorableio/woo)

The Woo stylguide integrates with your Rails app, using your existing css.

## Setup

### Add the Gem

```ruby
# Gemfile
gem 'woo'
```

### Mount the Woo Engine

```ruby
# config/routes.rb
mount Woo::Engine, at: '/styleguide'
```

## Generators

Woo features 2 generators to create views used within the styleguide.

### Pages
Creates `app/views/styleguide/DIRECTORY/NAME.html.haml`

If `DIRECTORY` is not specified, it will default to 'pages'.

```
rails generate woo:page [DIRECTORY/]NAME
```

### UI Elements
Creates `app/views/styleguide/ui_elements/_NAME.html.haml`

UI Elements are rendered as partials rather than individual pages.

```
rails generate styleguide:ui_element NAME
```<commit_msg>Document configuration in README<commit_after># Woo
[![Build Status](https://travis-ci.org/adorableio/woo.svg?branch=master)](https://travis-ci.org/adorableio/woo)

The Woo stylguide integrates with your Rails app, using your existing css.

## Setup

### Add the Gem

```ruby
# Gemfile
gem 'woo'
```

### Mount the Woo Engine

```ruby
# config/routes.rb
mount Woo::Engine, at: '/styleguide'
```

## Generators

Woo features 2 generators to create views used within the styleguide.

### Pages
Creates `app/views/styleguide/DIRECTORY/NAME.html.haml`

If `DIRECTORY` is not specified, it will default to 'pages'.

```
rails generate woo:page [DIRECTORY/]NAME
```

### UI Elements
Creates `app/views/styleguide/ui_elements/_NAME.html.haml`

UI Elements are rendered as partials rather than individual pages.

```
rails generate styleguide:ui_element NAME
```

### Configuration

```ruby
# config/application.rb

# Add your custom woo to the styleguide
config.woo.stylesheets << 'my_woo_styles.css'

# Use only your JS in the styleguide
config.woo.javascripts = ['my_woo.js']
```
{'fraction_non_alphanumeric': 0.13462545835515977, 'fraction_numerical': 0.0010476689366160294, 'mean_word_length': 4.858895705521473, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '7599275', 'n_tokens_mistral': 685, 'n_tokens_neox': 652, 'n_words': 186}