Project

woo

0.01
No commit activity in last 3 years
No release in over 3 years
There's a lot of open issues
A mountable styleguide to drive your development
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies
 Project Readme

Woo

Build Status

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']