@version 1.0

DSS, Documented Style Sheets, is a Grunt plugin that exposes a KSS style of comment blocking and parser of CSS, LESS, SASS and SCSS code for UI documentation generation.

/**
  * @name Button
  * @description Your standard form button.
  * 
  * @state :hover - Highlights when hovering.
  * @state :disabled - Dims the button when disabled.
  * @state .primary - Indicates button is the primary action.
  * @state .smaller - A smaller button
  * 
  * @markup
  *   <button>This is a button</button>
  */ 

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install DSS --save-dev

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('DSS');

In your project's Gruntfile, add a section named DSS to the data object passed into grunt.initConfig().

grunt.initConfig({
  DSS: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Type: String Default value: default

A relative path to a mustache template to be used instead of the default