4F - Fenomenal Formless Frontend Framework

This is a template for kss-node styleguide. "kss-node" is a NodeJS implementation of Knyle Style Sheets (KSS). kss-node enables us to generate a beatiful styleguide for CSS, of course that suports LESS, SASS and Stylus.

You can see the example styleguide from the left navi. That is thanks to Twitter Bootstrap.

How to apply this template

  1. Install kss-node. Type npm install kss or npm install -g kss for global CLI.
  2. Download kss-node-template and copy the "template" folder into your working directory.
  3. Run kss-node command with --template option, like below.
kss-node <sourcedir> --template path/to/template

Installation

As kss-node is provided as a npm package, you can install by just typing npm install kss. If you want to use the command line interface, install it globally.

npm install -g kss

As you see in the above samples, kss-node comment has some blocks. From the top,

  1. Element's title
  2. Element's description
  3. List of modifier classes or pseudo-classes
  4. HTML markup
  5. Reference to the element's position in the styleguide

And each description supports the Markdown writing.

More example code

This document is also created by using kss-node. You can see the source code in the demo directory.

Fork me on GitHub