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
- Install kss-node. Type
npm install kssornpm install -g kssfor global CLI. - Download kss-node-template and copy the "template" folder into your working directory.
- Run
kss-nodecommand with--templateoption, 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,
- Element's title
- Element's description
- List of modifier classes or pseudo-classes
- HTML markup
- 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.
