Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README.md

Reflects new changes to command-line options. Also including a list of
contributors and tweaking the example javascript snippet.

Unfortunately the swap from Windows to Unix line-endings means the diff's a
bit messed up.
  • Loading branch information...
commit bdc33467f7e9840f7d73b0795bdf6c251a6e3097 1 parent 8d80a8d
@hughsk hughsk authored
Showing with 98 additions and 95 deletions.
  1. +98 −95 README.md
View
193 README.md
@@ -1,95 +1,98 @@
-# kss-node [![Build Status](https://secure.travis-ci.org/hughsk/kss-node.png?branch=master)](http://travis-ci.org/hughsk/kss-node)
-
-This is a NodeJS implementation of [Knyle Style Sheets](https://github.com/kneath/kss) (KSS), "a documentation syntax for CSS". Beyond that, it's intended to have syntax readable by humans *and* machines - hence, this module can be used to create a "living styleguide". The methodology and ideas behind Knyle Style Sheets are contained in [the specification](https://github.com/kneath/kss/blob/master/SPEC.md).
-
-There's an example project in the [demo directory](https://github.com/hughsk/kss-node/tree/master/demo) of this repo.
-
-## Installation
-
-Just one line: `npm install kss`. If you want to use the command line interface, make sure the installation is global: `npm install -g kss`
-
-## Using the CLI
-
-To get you up and running quickly, a styleguide generator is included that can be used from the command line. It parses a directory of stylesheets and spits out a set of static HTML files like the ones used on this site.
-
- Usage:
- kss-node sourcedir [destdir] --less [file] --css [file]
-
- Options:
- -l, --less Compile and include a LESS stylesheet [string]
- -c, --css Compile and include a CSS stylesheet [string]
- -t, --template Use a custom template to build your styleguide [string]
-
-You'll need to specify a directory containing all of your CSS files to be parsed for documentation as the first argument. Optionally, the second argument can be used to specify a target directory. Your CSS won't be included by default, hence you should use the `--less`, `--css`, etc. flags to point to a stylesheet to compile and include. You can generate a copy of the demo styleguide like so:
-
- $ kss-node demo styleguide --less demo/styles.less
-
-You can create your own templates too, either by editing the contents of the `lib/template` directory or using the `--template` flag to point to your own. The default template should look something like this:
-
-![CLI Template Preview](https://raw.github.com/hughsk/kss-node/develop/demo/preview.png)
-
-## Using kss-node from Node
-
-Check out the [Module API](https://github.com/hughsk/kss-node/wiki/Module-API) a full explanation. Here's an example:
-
- var kss = require('kss'),
- options = {
- markdown: false
- };
-
- kss.traverse('public/stylesheets/', options, function(err, styleguide) {
- if (err) { throw err; }
-
- styleguide.section('2.1.1') // <KssSection>
-
- styleguide.section('2.1.1').description() // A button suitable for giving stars to someone
-
- styleguide.section('2.1.1').modifiers(0) // <KssModifier>
-
- styleguide.section('2.1.1').modifiers(0).name // ':hover'
-
- styleguide.section('2.1.1').modifiers(0).description // 'Subtle hover highlight'
-
- styleguide.section('2.1.1').modifiers(':hover').description() // 'Subtle hover highlight'
-
- styleguide.section('2.1.1').modifiers(0).className() // 'pseudo-class-hover'
-
- styleguide.section('2.x.x') // [<KssSection>, ...]
-
- styleguide.section('2.1.1').modifiers() // [<KssModifier>, ...]
-
- });
-
-
-## Differences
-
-Included are a few additional (optional) features to allow for completely automated styleguide generation.
-
-Take a look at the [demo project](http://github.com/hughsk/kss-node/tree/master/demo) for some examples.
-
-* **Overview Document**. This "overview" page is generated from a Markdown file, which you should place in the directory you're generating from, just name it `styleguide.md` and it will be included in the final styleguide automatically.
-
-
-* **HTML Markup**. In `kss-node` you can include sample markup in your styleguide entries. This is not only helpful for newcomers to a project, but is also used by the generator to include samples in your styleguide - just start a paragraph in your description section with `Markup:` like so:
-
-```less
-// Buttons
-//
-// Buttons can and should be clicked.
-//
-// Markup: <button class="button {$modifiers}">
-//
-// :hover - Highlight the button when hovered.
-//
-// Styleguide 1.1
-```
-
-* **Multi-line descriptions**. You can run your descriptions over multiple lines and paragraphs, and if you don't want to include the "modifiers" section you don't have to.
-
-## Development
-
-Forking, hacking, tearing apart of this module welcome - it still needs some cleaning up.
-
-If you've got [mocha](https://github.com/visionmedia/mocha) installed, you can run the module's tests with `npm test` or `make test`.
-
-To generate a new version of the demo styleguide, use `make gh-pages`. After committing your changes to master you can use the `gh-pages.sh` script to move this over to the `gh-pages` branch real quick.
+# kss-node [![Build Status](https://secure.travis-ci.org/hughsk/kss-node.png?branch=master)](http://travis-ci.org/hughsk/kss-node)
+
+This is a NodeJS implementation of [Knyle Style Sheets](https://github.com/kneath/kss) (KSS), "a documentation syntax for CSS". Beyond that, it's intended to have syntax readable by humans *and* machines - hence, this module can be used to create a "living styleguide". The methodology and ideas behind Knyle Style Sheets are contained in [the specification](https://github.com/kneath/kss/blob/master/SPEC.md).
+
+There's an example project in the [demo directory](https://github.com/hughsk/kss-node/tree/master/demo) of this repo.
+
+## Installation
+
+Just one line: `npm install kss`. If you want to use the command line interface, make sure the installation is global: `npm install -g kss`
+
+## Using the CLI
+
+To get you up and running quickly, a styleguide generator is included that can be used from the command line. It parses a directory of stylesheets and spits out a set of static HTML files like the ones used on this site.
+
+```
+Usage:
+ kss-node sourcedir [destdir] --init [directory] --{style,less,sass,stylus} [file]
+
+Options:
+ -t, --template Use a custom template to build your styleguide [string]
+ -s, --style Compile and include a stylesheet [string]
+ -l, --less Compile and include a LESS stylesheet [string]
+ -y, --stylus Compile and include a Stylus stylesheet [string]
+ -S, --sass Compile and include a SASS stylesheet [string]
+ -c, --css Compile and include a CSS stylesheet [string]
+ -i, --init Create a new styleguide template to work from
+```
+
+You'll need to specify a directory containing all of your CSS files to be parsed for documentation as the first argument. Optionally, the second argument can be used to specify a target directory. Your CSS won't be included by default, hence you should use the `--less`, `--css`, etc. flags to point to a stylesheet to compile and include. You can generate a copy of the demo styleguide like so:
+
+ $ kss-node demo styleguide --less demo/styles.less
+
+You can create your own templates too, either by editing the contents of the `lib/template` directory or using the `--template` flag to point to your own. The default template should look something like this:
+
+![CLI Template Preview](https://raw.github.com/hughsk/kss-node/develop/demo/preview.png)
+
+## Using kss-node from Node
+
+Check out the [Module API](https://github.com/hughsk/kss-node/wiki/Module-API) a full explanation. Here's an example:
+
+``` javascript
+var kss = require('kss'),
+ options = {
+ markdown: false
+ };
+
+kss.traverse('public/stylesheets/', options, function(err, styleguide) {
+ if (err) throw err;
+
+ styleguide.section('2.1.1') // <KssSection>
+ styleguide.section('2.1.1').description() // A button suitable for giving stars to someone
+ styleguide.section('2.1.1').modifiers(0) // <KssModifier>
+ styleguide.section('2.1.1').modifiers(0).name // ':hover'
+ styleguide.section('2.1.1').modifiers(0).description // 'Subtle hover highlight'
+ styleguide.section('2.1.1').modifiers(':hover').description() // 'Subtle hover highlight'
+ styleguide.section('2.1.1').modifiers(0).className() // 'pseudo-class-hover'
+ styleguide.section('2.x.x') // [<KssSection>, ...]
+ styleguide.section('2.1.1').modifiers() // [<KssModifier>, ...]
+});
+```
+
+## Differences
+
+Included are a few additional (optional) features to allow for completely automated styleguide generation.
+
+Take a look at the [demo project](http://github.com/hughsk/kss-node/tree/master/demo) for some examples.
+
+*Overview Document**. This "overview" page is generated from a Markdown file, which you should place in the directory you're generating from, just name it `styleguide.md` and it will be included in the final styleguide automatically.
+
+**HTML Markup**. In `kss-node` you can include sample markup in your styleguide entries. This is not only helpful for newcomers to a project, but is also used by the generator to include samples in your styleguide - just start a paragraph in your description section with `Markup:` like so:
+
+``` javascript
+// Buttons
+//
+// Buttons can and should be clicked.
+//
+// Markup: <button class="button {$modifiers}">
+//
+// :hover - Highlight the button when hovered.
+//
+// Styleguide 1.1
+```
+
+**Multi-line descriptions**. You can run your descriptions over multiple lines and paragraphs, and if you don't want to include the "modifiers" section you don't have to.
+
+## Development
+
+Forking, hacking, tearing apart of this module welcome - it still needs some cleaning up.
+
+If you've got [mocha](https://github.com/visionmedia/mocha) installed, you can run the module's tests with `npm test` or `make test`.
+
+To generate a new version of the demo styleguide, use `make gh-pages`. After committing your changes to master you can use the `gh-pages.sh` script to move this over to the `gh-pages` branch real quick.
+
+## Contributors
+
+* [Warin](http://github.com/Warin)
+* [Manuel Goerlich](http://github.com/MaThGo)
+* [Kevin Lamping](http://github.com/klamping)
Please sign in to comment.
Something went wrong with that request. Please try again.