Skip to content
Browse files

documentation

  • Loading branch information...
1 parent 02dcca6 commit b5cd5f71941206e5cbbb0c390c0c3dcf5af3b1b7 @tkellen tkellen committed Nov 28, 2012
Showing with 18 additions and 44 deletions.
  1. +10 −21 README.md
  2. +7 −7 docs/less-options.md
  3. +1 −16 docs/less-overview.md
View
31 README.md
@@ -17,61 +17,50 @@ npm install grunt-contrib-less --save-dev
## Less task
_Run this task with the `grunt less` command._
-### Overview
+_This task is a [multi task][] so any targets, files and options should be specified according to the [multi task][] documentation._
+[multi task]: https://github.com/gruntjs/grunt/wiki/Configuring-tasks
-In your project's Gruntfile, add a section named `less` to the data object passed into `grunt.initConfig()`.
-```js
-grunt.initConfig({
- less: {
- options: {
- // Task-specific options go here.
- },
- your_target: {
- // Target-specific file lists and/or options go here.
- },
- },
-})
-```
### Options
-#### options.paths
+#### paths
Type: `String|Array`
Default: Directory of input file.
Specifies directories to scan for @import directives when parsing. Default value is the directory of the source, which is probably what you want.
-#### options.compress
+#### compress
Type: `Boolean`
Default: False
Compress output by removing some whitespaces.
-#### options.yuicompress
+#### yuicompress
Type: `Boolean`
Default: False
Compress output using cssmin.js
-#### options.optimization
+#### optimization
Type: `Integer`
Default: null
Set the parser's optimization level. The lower the number, the less nodes it will create in the tree. This could matter for debugging, or if you want to access the individual nodes in the tree.
-#### options.strictImports
+#### strictImports
Type: `Boolean`
Default: False
Force evaluation of imports.
-#### options.dumpLineNumbers
+#### dumpLineNumbers
Type: `String`
Default: false
Configures -sass-debug-info support.
Accepts following values: `comments`, `mediaquery`, `all`.
+
### Usage Examples
```js
@@ -108,4 +97,4 @@ less: {
Task submitted by [Tyler Kellen](http://goingslowly.com/)
-*This file was generated on Tue Nov 13 2012 16:14:04.*
+*This file was generated on Wed Nov 28 2012 08:42:08.*
View
14 docs/less-options.md
@@ -1,39 +1,39 @@
# Options
-## options.paths
+## paths
Type: `String|Array`
Default: Directory of input file.
Specifies directories to scan for @import directives when parsing. Default value is the directory of the source, which is probably what you want.
-## options.compress
+## compress
Type: `Boolean`
Default: False
Compress output by removing some whitespaces.
-## options.yuicompress
+## yuicompress
Type: `Boolean`
Default: False
Compress output using cssmin.js
-## options.optimization
+## optimization
Type: `Integer`
Default: null
Set the parser's optimization level. The lower the number, the less nodes it will create in the tree. This could matter for debugging, or if you want to access the individual nodes in the tree.
-## options.strictImports
+## strictImports
Type: `Boolean`
Default: False
Force evaluation of imports.
-## options.dumpLineNumbers
+## dumpLineNumbers
Type: `String`
Default: false
Configures -sass-debug-info support.
-Accepts following values: `comments`, `mediaquery`, `all`.
+Accepts following values: `comments`, `mediaquery`, `all`.
View
17 docs/less-overview.md
@@ -1,16 +1 @@
-# Overview
-
-In your project's Gruntfile, add a section named `less` to the data object passed into `grunt.initConfig()`.
-
-```js
-grunt.initConfig({
- less: {
- options: {
- // Task-specific options go here.
- },
- your_target: {
- // Target-specific file lists and/or options go here.
- },
- },
-})
-```
+{%= s.multi_task %}

0 comments on commit b5cd5f7

Please sign in to comment.
Something went wrong with that request. Please try again.