Skip to content

KSS standalone command-line script. Perfect for build processes!

Notifications You must be signed in to change notification settings

tmanderson/kss-standalone

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

##KSSS - KSS Standalone Documentation Creation ###A command-line utility


ksss.rb takes your given CSS directory and spits out a coherent HTML document. This is, of course, using the awesome KSS parser/spec.

Using KSSS is simple, just run the file and give it your CSS directory. Optionally, you can give it the section numbers you want to include in your documentation creation. If you choose to go without sections, make sure in you use the same section number for all areas of your documentation.

> ksss.rb relative/path/to/css 1.1 1.2 2.1

###Configuration

Check the templates/styleguide for help on how to add your styles to documentation. Basically just add your styles to the file, and add blocks that call helper function like this:

<% styleguide_block '1.1', "<button class='$modifier_class'>Example Button</button>"  do %>
<% end %>

First parameter to helper function call is the section, second parameter is an example block that the styles will have effect to.

The actual template which renders the helper visuals to documentation is stolen from the KSS example Sinatra application.

About

KSS standalone command-line script. Perfect for build processes!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages