Skip to content

Commit

Permalink
Normalize doc style
Browse files Browse the repository at this point in the history
  • Loading branch information
shama committed Sep 12, 2013
1 parent 4cb13b0 commit 1b27f3f
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 21 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,20 +32,20 @@ This task comes preloaded with [nib](http://visionmedia.github.com/nib/).
### Options

#### compress
Type: `Boolean`
Default: true
Type: `Boolean`
Default: `true`

Specifies if we should compress the compiled css. Compression is always disabled when `--debug` flag is passed to grunt.

#### linenos
Type: `Boolean`
Default: false
Type: `Boolean`
Default: `false`

Specifies if the generated CSS file should contain comments indicating the corresponding stylus line.

#### firebug
Type: `Boolean`
Default: false
Type: `Boolean`
Default: `false`

Specifies if the generated CSS file should contain debug info that can be used by the FireStylus Firebug plugin

Expand Down Expand Up @@ -76,18 +76,20 @@ Import given stylus packages into every compiled `.styl` file, as if you wrote `
in every single one of said files.

#### include css
Type: `Boolean` Default: false
Type: `Boolean`
Default: `false`

When including a css file in your app.styl by using @import "style.css", by default it will not include the full script, use `true` to compile into one script. ( NOTICE: the object key contains a space )

#### [resolve url](http://learnboost.github.io/stylus/docs/executable.html#resolving-relative-urls-inside-imports)
Type: `Boolean` Default: false
Type: `Boolean`
Default: `false`

Telling Stylus to generate `url("bar/baz.png")` in the compiled CSS files accordingly from `@import "bar/bar.styl"` and `url("baz.png")`, which makes relative pathes work in Stylus.

#### banner
Type: `String`
Default: empty string
Type: `String`
Default: `''`

This string will be prepended to the beginning of the compiled output. It is processed using [grunt.template.process][], using the default options.

Expand Down Expand Up @@ -140,4 +142,4 @@ stylus: {

Task submitted by [Eric Woroshow](http://ericw.ca)

*This file was generated on Wed Sep 11 2013 22:09:10.*
*This file was generated on Wed Sep 11 2013 22:11:53.*
22 changes: 12 additions & 10 deletions docs/stylus-options.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Options

## compress
Type: `Boolean`
Default: true
Type: `Boolean`
Default: `true`

Specifies if we should compress the compiled css. Compression is always disabled when `--debug` flag is passed to grunt.

## linenos
Type: `Boolean`
Default: false
Type: `Boolean`
Default: `false`

Specifies if the generated CSS file should contain comments indicating the corresponding stylus line.

## firebug
Type: `Boolean`
Default: false
Type: `Boolean`
Default: `false`

Specifies if the generated CSS file should contain debug info that can be used by the FireStylus Firebug plugin

Expand Down Expand Up @@ -45,18 +45,20 @@ Import given stylus packages into every compiled `.styl` file, as if you wrote `
in every single one of said files.

## include css
Type: `Boolean` Default: false
Type: `Boolean`
Default: `false`

When including a css file in your app.styl by using @import "style.css", by default it will not include the full script, use `true` to compile into one script. ( NOTICE: the object key contains a space )

## [resolve url](http://learnboost.github.io/stylus/docs/executable.html#resolving-relative-urls-inside-imports)
Type: `Boolean` Default: false
Type: `Boolean`
Default: `false`

Telling Stylus to generate `url("bar/baz.png")` in the compiled CSS files accordingly from `@import "bar/bar.styl"` and `url("baz.png")`, which makes relative pathes work in Stylus.

## banner
Type: `String`
Default: empty string
Type: `String`
Default: `''`

This string will be prepended to the beginning of the compiled output. It is processed using [grunt.template.process][], using the default options.

Expand Down

0 comments on commit 1b27f3f

Please sign in to comment.