grunt-kss
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" task
Overview
In your project's Gruntfile, add a section named kss
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
kss: {
options: {
includeType: 'css',
includePath: '/path/to/include.css',
},
dist: {
files: {
'/path/to/destdir': ['/path/to/sourcedir']
}
}
}
})
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 incluede 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.
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.