Rails generator to build a styleguide
Switch branches/tags
Pull request Compare This branch is 53 commits behind begriffs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
illustration
lib
.gitignore
Gemfile
LICENSE
README.md
Rakefile
styleguide_rails.gemspec

README.md

Logo

Adds a living style guide to your Rails application with one command.

If you don't use a CSS style guide yet, here's why you need to start:

  • It Makes Testing Easier. With all your styles in one place you can easily check for browser bugs, resizing issues, text zoom issues, and printable style. Putting examples of all styles in one place means you don't have to reproduce application states to see error messages etc.
  • It Unifies Design. Designing shared components all at once fights the temptation to have one-off page styles. This increases the coherence of your design, making it less likely that styles drift between pages. It also encourages cleaner markup.
  • It Standardizes Vocabulary. Style guides list all your widgets along with names you have chosen. By referring to the guide, your team can settle on common vocabulary for parts of the page. (e.g. "What does my team call this thing on the front page, a slider, a carousel, a flipper, or what?")
  • It Promotes Excellent Markup. The styleguide contains examples of your desired canonical markup for various elements. Nobody needs to guess how to create a menu or a form. Also your best front-end engineers can write the markup and teach good habits.

Usage

Add this gem to your Rails Gemfile:

gem 'styleguide_rails'

Run bundle, and execute the styleguide generator:

$ rails generate styleguide:install

That's it, you're done, you have a styleguide available at http://yourapp.com/styleguide. If you visit that path you'll see there is an example widget already created:

Screenshot

To add a new widget, create a partial in app/views/styleguide/widgets and it will appear in the style guide. These partials support templating languages like Haml if you have the gems installed.

Credits

Thanks to project contributors, and to Adam Braus for suggesting the idea for this gem.

License

Styleguide_rails is Copyright © 2012 - 2013 Joe Nelson. It is free software, and may be redistributed under the terms specified in the LICENSE file.