UNPKG

grunt-verb

Version:

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

58 lines (37 loc) 1.47 kB
# grunt-verb [![NPM version](https://badge.fury.io/js/grunt-verb.png)](http://badge.fury.io/js/grunt-verb) > Grunt plugin for Verb, the deadliest markdown documentation generator in the Alpha Quadrant. Please [report any bugs or feature requests](https://github.com/assemble/grunt-verb/issues/new), thanks! ## Install ##### [npm](npmjs.org): ```bash npm install grunt-verb --save-dev ``` ## Examples Example document: ```js # {%= 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). In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Build the documentation with [Verb](https://github.com/assemble/Verb). Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! 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 February 20, 2014._