gulp-kss

Gulp plugin for KSS (Knyle Stype Sheets) documentation generation.

This plugin is based on kss-node and generates a styleguide based on code documentation. The plugin is mainly a fork of kss-nodes's bin script, not how a beautiful gulp plugin should look like, but it works.

This plugin currently lacks tests.

Install

npm install gulp-kss

Usage

Pipe all source files you want to document through gulp-kss, also the ones which are usually imported.

In addition to that you need to create a concated and compiled version of your styles at public/style.css.

var gulp = require('gulp');
var gulpless = require('gulp-less');
var gulpkss = require('gulp-kss');
var gulpconcat = require('gulp-concat');

gulp.src(['styles/**/*.less'])
    .pipe(gulpkss({
        overview: __dirname + '/styles/styleguide.md'
    }))
    .pipe(gulp.dest('styleguide/'));

// Concat and compile all your styles for correct rendering of the styleguide.
gulp.src('styles/main.less')
    .pipe(gulpless())
    .pipe(gulpconcat('public/style.css'))
    .pipe(gulp.dest('styleguide/'));

Markup-Templates

If you like to use template files for the markup section, then you can use single files in a markup directory. In your KSS comments use the following declaration to include the markup file:

//
// Markup:
// includeTemplate path/to/your/file.html
//

And in your gulpfile.js you set the markupDirectory:

…
gulp.src(options.src.styleguide.kss)
    .pipe(kss({
         markupDirectory : 'src/templates',
         overview: __dirname + 'src/styleguide/overview.md'
         templateDirectory : 'src/styleguide/template'
    }))
    .pipe(gulp.dest(options.target.styleguide.build));
…

Template

To use the possibility of markup files, you must use the template of this repository, because there are modified handlebar helpers.

Options

• overview: Absolute path to markdown file which is used for styleguide home page
• markupDirectory: path to the markup directory, by default no template files are used.
• templateDirectory: path to template directory, by default kss-node default template is used.
• kss: Options supported by kss-node

LICENSE

(MIT License)

Copyright (c) 2014 DigitalWerft [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.