No Padding Margin

    grunt-kss-styleguide

    0.1.1 • Public • Published

    grunt-kss

    Build Status NPM version Dependency Status

    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: {
          includeType: 'css',
          includePath: '/path/to/include.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.includeType

    Type: String Default value: null

    style, less, stylus, sass, css

    A string value that is used to compile and include to build your style.

    options.includePath

    Type: String Default value: null

    A string value that is used to specify include stylesheet path.

    options.template

    Type: String Default value: null

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

    options.mask

    Type: String Default value: null

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

    options.loadPath

    Type: String or Array Default value: null

    Include a load path for preprocessor imports Currently only sass is supported.

    options.helpers

    Type: String Default value: null

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

    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.

    Release History

    • v0.4.0: Add option outputStyle.
    • v0.3.1: Add scss compiler.
    • v0.2.6: Fix "Error: spawn ENOENT" bug for Windows.
    • v0.2.4: Fix kss-node module path.
    • v0.2.3: Bump version.
    • v0.2.2: Fix README.
    • v0.2.0: Fix a cmd path.
    • v0.1.0: Release.

    Install

    npm i grunt-kss-styleguide

    DownloadsWeekly Downloads

    0

    Version

    0.1.1

    License

    none

    Last publish

    Collaborators

    • alexbrendon