README.md

assemble-middleware-kssnode

Generates Assemble pages from Knyle Style Sheets (KSS) documented CSS.

Originally forked from assemble-middleware-styleguide with modifications from KSS Node. This middleware does pretty much the same thing except that it relies directly on KSS node rather than another fork. Another reason to make this module was the need to include KSS node generated pages in the site navigation as well as being able to parse arbitrary CSS files.

Installation

Run from the command line:

npm install assemble-middleware-kssnode --save-dev

Getting started

To register the plugin with Assemble in your project's Gruntfile you can simply add the module's name to the plugins option:

assemble: {
  options {
    layout: ['templates/layouts/default.hbs'],
    partials: ['templates/partials/**/*.hbs'],
    plugins: ['assemble-middleware-kssnode', 'other/plugins/*.js']
  },
  styleguide: {
    options: {
	    kssnode: {
	      page: 'templates/pages/styleguide.hbs', // Page template for each section
	      dest: 'dist',
	      src: 'src/css'
	      mask: '*.css' // Optional
	    }
	  },
    files: [{
      expand: true,
      cwd: 'templates/pages',
      src: ['**/*.hbs'],
      dest: 'dist'
    }]
  }
}

Running the task creates an Assemble Page Object for each KSS root section and exposes a sections collection that is created with the KSS Node Module API in every instance of the provided Handlebars template.