Kalei - Style guide

This project aims at making sure your style sheets are fully documented whilst being synchronized with your webpages styles. To do this it actually uses your live stylesheets in so that at anytime you can review how your styleguide looks.

Main goals and benefits

• Fully documented CSS - No need to explain the benefits
• No dependencies, simply download the repository and run in your browser
• Automatic generation of demo UI components
• Easy access for anyone, designer, developer, manager and users
• Rapid development of projects by allowing developers to find the correct CSS and HTML for any given UI component
• Open sourced so that all great ideas can be included

Getting started

1. Download the repository (git clone git://github.com/kaleistyleguide/kaleistyleguide.git)
2. Serve it on a HTTP server and it should work!
3. Edit js/config.js to point at your own styles.css

Author

Thomas Davis Luke Brooker Richard Barret

Inspiration

Kalei is heavily influenced by the following projects and blog posts.

Pea.rs

KSS

StyleDocco

RJ Metrics

Anchoring Your Design Language in a Live Style Guide

Technologies

• marked
• jscssp
• cssbeautify
• fixie
• highlight
• backbone
• underscore
• jquery

License

Public domain: http://unlicense.org/