Woo
The Woo styleguide integrates with your Rails app, using your existing CSS.
Setup
Add the Gem
# Gemfile
gem 'woo'
Mount the Woo Engine
# 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 woo:ui_element NAME
Configuration
By default, Woo will load your main assets files (application.js
and application.css
) in addition to its own.
However, you can override that behavior:
# config/application.rb
# Add your custom Woo styles
config.woo.stylesheets << 'my_woo_styles.css'
# Use only your JS in the styleguide
config.woo.javascripts = ['my_woo.js']