Skip to content

Commit

Permalink
Updated read me and bumped version
Browse files Browse the repository at this point in the history
  • Loading branch information
indieisaconcept committed Oct 5, 2013
1 parent 25d171c commit 193e43f
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 40 deletions.
82 changes: 43 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
<tr>
<th>Framework</th>
<th>Preprocessor</th>
<th>Templates</th>
<th>Templates</th>
</tr><tr>
<td><a href="http://jacobrask.github.com/styledocco/">styledocco</a></td>
<td>Less, SASS</td>
<td>Default template provided by styledocco is used</td>
<td>Default template provided by styledocco is used</td>
</tr><tr>
<td><a href="https://github.com/hughsk/kss-node">kss-node</a></td>
<td>Less</td>
<td>Custom templates can be used</td>
<td>Custom templates can be used</td>
</tr>
</table>

Expand Down Expand Up @@ -57,25 +57,25 @@ In your project's Gruntfile, add a section named `styleguide` to the data object
grunt.initConfig({
styleguide: {
options: {
// global options
},
your_target: {
options: {
// task options
},
files: {
// files to process
// files to process
}
}
}
})
```
An example configuration can be view [here](https://gist.github.com/3932026)
Expand All @@ -91,62 +91,62 @@ By default **grunt-styleguide** will attempt to rationalize options for each of
<th>Key</th>
<th>Type</th>
<th>Default</th>
<th>Required</th>
<th>Required</th>
<th>Description</th>
</tr><tr>
<td>framework</td>
<td>String, object, function (*)</td>
<td>styledocco</td>
<td>No</td>
<td>Details about the styleguide framework</td>
<td>Details about the styleguide framework</td>
</tr><tr>
<td>name</td>
<td>String</td>
<td>undefined</td>
<td>undefined</td>
<td>No</td>
<td>Title of the styleguide</td>
<td>Title of the styleguide</td>
</tr><tr>
<td>template</td>
<td>Object</td>
<td>Template bundled with framework</td>
<td>Template bundled with framework</td>
<td>No</td>
<td>Details of the templetes to use for rendering if supported</td>
<td>Details of the templetes to use for rendering if supported</td>
</tr><tr>
<td>files</td>
<td>Object, String, Array</td>
<td>undefined</td>
<td>undefined</td>
<td>Yes</td>
<td>Details of the templetes to use for rendering if supported</td>
<td>Details of the templetes to use for rendering if supported</td>
</tr>
</table>

> \* See [extending grunt-styleguide]()
#### Framework Options

Should you wish to pass additional options which are supported by a framework then these can be passed as an options as part of the framework object.
Should you wish to pass additional options which are supported by a framework then these can be passed as an options as part of the framework object.

```
styleguide: {
dist: {
options: {
framework: {
name: 'framework_name',
options: {
'somearg': 'somevalue',
'someflag: true
}
}
},
files: {
'path/to/dest': 'path/to/source'
}
}
}
Expand All @@ -160,18 +160,18 @@ Depending upon the framework, it may be possible to also pass templates to use f
styleguide: {
dist: {
options: {
template: {
src: 'path/to/templates',
include: ['path/of/resources/to/include']
}
files: {
'path/to/dest': 'path/to/source'
}
}
}
Expand All @@ -183,18 +183,18 @@ styleguide: {
<tr>
<th>Key</th>
<th>Type</th>
<th>Required</th>
<th>Required</th>
<th>Description</th>
</tr><tr>
<td>src</td>
<td>String</td>
<td>No</td>
<td>Location of the template to use</td>
<td>Location of the template to use</td>
</tr><tr>
<td>include</td>
<td>String, Array</td>
<td>No</td>
<td>Title of the styleguide</td>
<td>Title of the styleguide</td>
</tr>
</table>

Expand Down Expand Up @@ -222,18 +222,18 @@ In this example a styleguide will be generated using the default generator, `sty
grunt.initConfig({
styleguide: {
dist: {
files: {
'docs/core': 'stylesheets/sass/core/*.scss',
'docs/core': 'stylesheets/sass/core/*.scss',
'docs/plugins': 'stylesheets/sass/plugins/*.scss',
}
}
}
}
});
```

Expand All @@ -242,9 +242,13 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.

## Release History

### 0.2.7

- Cumulative fixes (Issues #18, #14, #11) [ sorry for the delay ]

### 0.2.6

- Minor code tweaks to resolve some user issues
- Minor code tweaks to resolve some user issues

### 0.2.5

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "grunt-styleguide",
"description": "Universal CSS styleguide generator for grunt",
"version": "0.2.6",
"version": "0.2.7",
"homepage": "https://github.com/indieisaconcept/grunt-styleguide",
"author": {
"name": "Jonathan Barnett",
Expand Down

0 comments on commit 193e43f

Please sign in to comment.