Ninja Parading Musically

    grunt-kss-node

    1.0.4 • Public • Published

    grunt-kss-node

    NPM version Dependency Status Built with Grunt

    Npm Downloads

    KSS styleguide generator for grunt.

    Getting Started

    This plugin requires Grunt ~0.4.x

    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 grunt-kss --save-dev

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

    grunt.loadNpmTasks('grunt-kss');

    The "kss" config and an example task

    Overview

    To set up the kss config, add a section named kss to the data object passed into grunt.initConfig(), in your project's Gruntfile.

    grunt.initConfig({
      kss: {
        options: {
          css: '/path/to/style.css',
        },
        dist: {
            files: {
              '/path/to/destdir': ['/path/to/sourcedir']
            }
       }
      }
    });

    Then, once you've added the config information above, you can add the kss build step to an existing task (not shown) or can create your own task. Here is an example task that you can create:

    grunt.registerTask('styleguide', [
      // Add other tasks here if needed
      'kss'
      // Add other tasks here if needed
    ]);

    Finally, you can call kss by running grunt styleguide.

    Options

    options.template

    Type: String Default value: null

    A string value that is used to use a custom template to build your styleguide.

    options.helpers

    Type: String Default value: null

    Specify the location of custom handlebars helpers; see http://bit.ly/kss-helpers

    options.mask

    Type: String Default value: null

    A string value that is used to use a custom mask for detecting stylesheets.

    options.custom

    Type: String Default value: null

    A string value that is used to use a custom property name when parsing KSS comments.

    options.css

    Type: String Default value: null

    A string value that is used to use including a CSS stylesheet for your styleguide.

    options.js

    Type: String Default value: null

    A string value that is used to use including a JavaScript file for your styleguide.

    options.config

    Type: String Default value: null

    Load the kss-node configuration from a JSON file

    Contributing

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

    Install

    npm i grunt-kss-node

    DownloadsWeekly Downloads

    4

    Version

    1.0.4

    License

    none

    Last publish

    Collaborators

    • lidl-cake
    • pkrueger
    • jeremiaseh
    • foued611
    • maiermat
    • schwarz-it