diff options
author | Zac Echola <zac.echola@gmail.com> | 2014-07-26 08:48:19 +0400 |
---|---|---|
committer | Zac Echola <zac.echola@gmail.com> | 2014-07-26 08:48:19 +0400 |
commit | f52415bdb2b1569bbfc5a09e1133d48a5cbd0c86 (patch) | |
tree | 22201d396add6b35c821b52c2cb9cceed2fa5c13 /README.md |
:seedling:
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..dbec1b6 --- /dev/null +++ b/README.md @@ -0,0 +1,89 @@ +# grunt-bootlint + +> An HTML linter for Bootstrap projects + +## Getting Started +This plugin requires Grunt `~0.4.5` + +If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command: + +```shell +npm install grunt-bootlint --save-dev +``` + +Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript: + +```js +grunt.loadNpmTasks('grunt-bootlint'); +``` + +## The "bootlint" task + +### Overview +In your project's Gruntfile, add a section named `bootlint` to the data object passed into `grunt.initConfig()`. + +```js +grunt.initConfig({ + bootlint: { + options: { + // Task-specific options go here. + }, + your_target: { + // Target-specific file lists and/or options go here. + }, + }, +}); +``` + +### Options + +#### options.separator +Type: `String` +Default value: `', '` + +A string value that is used to do something with whatever. + +#### options.punctuation +Type: `String` +Default value: `'.'` + +A string value that is used to do something else with whatever else. + +### Usage Examples + +#### Default Options +In this example, the default options are used to do something with whatever. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result would be `Testing, 1 2 3.` + +```js +grunt.initConfig({ + bootlint: { + options: {}, + files: { + 'dest/default_options': ['src/testing', 'src/123'], + }, + }, +}); +``` + +#### Custom Options +In this example, custom options are used to do something else with whatever else. So if the `testing` file has the content `Testing` and the `123` file had the content `1 2 3`, the generated result in this case would be `Testing: 1 2 3 !!!` + +```js +grunt.initConfig({ + bootlint: { + options: { + separator: ': ', + punctuation: ' !!!', + }, + files: { + 'dest/default_options': ['src/testing', 'src/123'], + }, + }, +}); +``` + +## 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](http://gruntjs.com/). + +## Release History +_(Nothing yet)_ |