Project

kalei

0.0
No commit activity in last 3 years
No release in over 3 years
Provides the Kalei style guide as a Rack mountable Ruby application.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Runtime

 Project Readme

Kalei - a living styleguide for your Ruby project

This gem provides an easy way to add the Kalei Styleguide to your existing Ruby application.

Rails Installation

Step 1: Add kalei to your Gemfile:

gem 'kalei', :require => 'kalei/engine'

Step 2: Add kalei to your config/routes.rb:

Rails.application.routes.draw do
  mount Kalei::Engine => "/style-guide"
end

Kalei will now be available in the browser at /style-guide. By default, it will parse your stylesheet at /assets/application.css. More configuration options coming soon.

Non-Rails Installation

Step 1: Add kalei to your Gemfile:

gem 'kalei'

Step 2: Add kalei to your config.ru:

require 'kalei/app'

map '/style-guide' do
  run Kalei::App
end

Kalei will now be available in the browser at /style-guide. By default, it will parse your stylesheet at /assets/application.css, which may not be correct for your application. More configuration options coming soon.