verb
Version:
Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.
64 lines (34 loc) • 1.75 kB
Markdown
# verb [](http://badge.fury.io/js/verb)
> Verb makes it easy to build project documentation using simple markdown templates, with zero configuration required.
## What is Verb?
### Ease of Use
> Verb loves users
Verb's number one priorty is ease-of use. For new users **zero configuration** is required to get started. Once Verb is installed, simply enter `docs` in command line, and you're off and running.
For more experienced users, Verb offers _more than 50 template tags and filters, includes and partial caching, comment parsing, YAML Front Matter (or Coffee Front Matter!), plugins, mixins, tons of helpful JavaScript and Node.js utilites_, and lots more.
### API
> Verb loves developers
Verb has an extensive API and tools for building plugins, custom tags and filters, or extending Verb in other ways.
Once installed globally, running `verb` at the command line will read any files in the `./docs` directory of your project. This is easily customized
will automatically gather information from your project's package.json and git repository, then
Use the CLI for to build
, or required as a node lib.
Verb keeps things simple by using well-defined conventions
Verbs advantage is that it comes with
## Install with [npm](npmjs.org)
```bash
npm i -g verb --save-dev
```
## Tests
Run Verb's 75+ unit tests with:
```
mocha -R spec
```
## Authors
**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 [Verb](https://github.com/assemble/verb) on March 15, 2014._