Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 68 lines (38 sloc) 1.961 kB
2c9131e Have a read me
Roland authored
1 # Kalei - Style guide
d4c7df1 @thomasdavis kalei is greek for beautiful
authored
2
2c9131e Have a read me
Roland authored
3 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.
4
167ee3d @Lockyc removed getclicky links
Lockyc authored
5
cd56ac7 @thomasdavis updated readme
authored
6 ## Main goals and benefits
2c9131e Have a read me
Roland authored
7
8 * Fully documented CSS - No need to explain the benefits
9 * No dependencies, simply download the repository and run in your browser
10 * Automatic generation of demo UI components
11 * Easy access for anyone, designer, developer, manager and users
12 * Rapid development of projects by allowing developers to find the correct CSS and HTML for any given UI component
13 * Open sourced so that all great ideas can be included
14
cd56ac7 @thomasdavis updated readme
authored
15
16
17
18
2c9131e Have a read me
Roland authored
19 ## Getting started
20
1dcc639 @thomasdavis updated readme
authored
21 1. Download the repository (`git clone git://github.com/kaleistyleguide/kaleistyleguide.git`)
2c9131e Have a read me
Roland authored
22 2. Serve it on a HTTP server and it should work!
167ee3d @Lockyc removed getclicky links
Lockyc authored
23 3. Edit `js/config.js` to point at your own `styles.css`
2c9131e Have a read me
Roland authored
24
cd56ac7 @thomasdavis updated readme
authored
25
2c9131e Have a read me
Roland authored
26 ## Author
27
28 [Thomas Davis](http://thomasdavis.github.com)
5aabecd @pospi update readme
pospi authored
29
30 ## Contributors
31
1dcc639 @thomasdavis updated readme
authored
32 Luke Brooker
5aabecd @pospi update readme
pospi authored
33 [Richard Barret](http://richardbarrett.github.io)
34 [Sam Pospischil](http://pospi.spadgos.com)
2c9131e Have a read me
Roland authored
35
4bdcba7 @thomasdavis reset
authored
36
60c5026 @thomasdavis updated readme again
authored
37
cd56ac7 @thomasdavis updated readme
authored
38 ## Inspiration
39
40 Kalei is heavily influenced by the following projects and blog posts.
41
42 [Pea.rs](http://pea.rs/)
43
44 [KSS](http://warpspire.com/posts/kss/)
45
46 [StyleDocco](http://jacobrask.github.com/styledocco/)
47
b64d3f1 @staeff Updated reference URL
staeff authored
48 [RJ Metrics](http://blog.rjmetrics.com/2012/02/20/our-living-style-guide-writing-maintainable-htmlcss/)
cd56ac7 @thomasdavis updated readme
authored
49
50 [Anchoring Your Design Language in a Live Style Guide](http://uxmag.com/articles/anchoring-your-design-language-in-a-live-style-guide)
51
52
167ee3d @Lockyc removed getclicky links
Lockyc authored
53 ## Technologies
cd56ac7 @thomasdavis updated readme
authored
54
55 * [marked](https://github.com/chjj/marked)
56 * [jscssp](http://www.glazman.org/JSCSSP/)
5aabecd @pospi update readme
pospi authored
57 * [LESS](http://lesscss.org/)
cd56ac7 @thomasdavis updated readme
authored
58 * cssbeautify
59 * [fixie](http://fixiejs.com/)
60 * [highlight](http://softwaremaniacs.org/soft/highlight/en/)
61 * [backbone](http://backbonejs.org/)
62 * [underscore](http://underscorejs.org/)
63 * [jquery](http://jquery.com)
64
167ee3d @Lockyc removed getclicky links
Lockyc authored
65 ## License
cd56ac7 @thomasdavis updated readme
authored
66
67 Public domain: http://unlicense.org/
Something went wrong with that request. Please try again.