grunt-verb/README.md

Grunt plugin for Verb, the markdown documentation generator with zero-configuration required.

# grunt-verb [![NPM version](https://badge.fury.io/js/grunt-verb.png)](http://badge.fury.io/js/grunt-verb)

> Grunt plugin for Verb, the markdown documentation generator with zero-configuration required.

Other [Verb](https://github.com/assemble/verb) tools:

* Get [verb-cli](https://github.com/assemble/verb-cli) to use Verb from the command line
* Get [generator-verb](https://github.com/assemble/generator-verb) to add documentation templates, or initialize docs for new projects
* Get [gulp-verb](https://github.com/assemble/gulp-verb) for gulp workflows

## Install with [npm](npmjs.org)
```bash
npm install grunt-verb --save-dev
```

You can also use the [Verb generator](https://github.com/assemble/generator-verb) to kickstart the documentation for any project.

Please [report any bugs or feature requests](https://github.com/assemble/grunt-verb/issues/new), thanks!

## Examples
You can build any kind of markdown document with Verb, but **building a readme is an easy way to get started**.

Here is an example template for a basic readme:

```markdown
# {%= name %}

> {%= description %}

{%= toc() %}

## Overview
{%= docs("overview") %}

## Options
{%= docs("options") %}

## Examples
{%= docs("examples") %}

## License and Copyright
{%= copyright() %}
{%= license() %}
```

## Contributing
Find a bug? Have a feature request? Please [create an Issue](https://github.com/assemble/grunt-verb/issues). If you find this project useful please consider "starring" it to show your support!

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

Pull requests are also encouraged, please re-build the documentation with [grunt-verb](https://github.com/assemble/grunt-verb) before you submit your pull request! Thanks!

## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License
Copyright (c) 2014 Jon Schlinkert, contributors.  
Released under the MIT license

***

_This file was generated by [grunt-verb](https://github.com/assemble/grunt-verb) on May 05, 2014._