Contents

# StyleGuide

[![Build Status](https://secure.travis-ci.org/pivotalexperimental/style-guide.png?branch=master)](https://travis-ci.org/pivotalexperimental/style-guide) [![Dependency Status](https://gemnasium.com/pivotalexperimental/style-guide.png)](https://gemnasium.com/pivotalexperimental/style-guide) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/pivotalexperimental/style-guide)

Quickly see the styled output of your application.

## Example

The canonical deployed instance is located at [http://swivel.herokuapp.com](http://swivel.herokuapp.com)

## Usage

First, require the StyleGuide gem in your application.rb file:

    Bundler.require
    require "style_guide"

Next, mount the StyleGuide application in your `routes.rb` file:

    mount StyleGuide::Engine => "/style-guide"

By default, StyleGuide will attempt to load directories full of partials and render them at its mounted path.  Here's how to add your own directory full of partials:

    config.style_guide.partial_paths << Rails.root.join("app/views/styles")

You could, however, just display only your partials (note the assignment):

    config.style_guide.partial_paths = [Rails.root.join("app/views/styles")]

## License

See `LICENSE` for more information.

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
style-guide-0.6.0	README.md
style-guide-0.5.0	README.md
style-guide-0.4.0	README.md
style-guide-0.3.0	README.md
style-guide-0.2.1	README.md
style-guide-0.2.0	README.md