UNPKG

verb

Version:

Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.

38 lines (24 loc) 1.2 kB
# {%= name %} {%= badge('fury') %} > {%= description %} * Get [verb-cli](https://github.com/assemble/verb-cli) to use Verb globally from the command line * Get [generator-verb](https://github.com/assemble/generator-verb) to add documentation templates, or initialize docs for new projects ## Meet Verb {%= docs('meet-verb') %} ## Customize Verb Verb is easy to extend, here are some examples ([verb-cli](https://github.com/assemble/verb-cli) will automatically use these): * [example verbfile](https://gist.github.com/jonschlinkert/9685280), with custom `src`, `dest` and metadata. * [example verbfile with logging](https://gist.github.com/jonschlinkert/9685144) * [example .verbrc.yml](https://gist.github.com/jonschlinkert/9686195) ## Install {%= include('install') %} Be sure to install [Verb](https://github.com/assemble/verb) locally in projects that use Verb. ## Other tools * Get [grunt-verb](https://github.com/assemble/grunt-verb) to automate Verb in your Grunt tool-chains * Get [gulp-verb](https://github.com/assemble/gulp-verb) to automate Verb in your gulp tool-chains ## Author {%= contrib("jon") %} ## License {%= copyright() %} {%= license() %} *** {%= include("footer") %}