verb

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

Get verb-cli to use Verb globally from the command line
Get generator-verb to add documentation templates, or initialize docs for new projects

Meet Verb

Verb's CLI makes kickstarting new markdown documentation a breeze.

For example, to generate a readme for your project just create a template, docs/README.tmpl.md, and add the following:

# {%= name %}

> {%= description %}

Sed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam.

And Verb will build this into README.md using data from your project's package.json.

Built-in tags

Need more than simple variables? Use one of Verb's built-in tags, like date():

## License
Copyright (c) {%= date('YYYY') %} {%= author.name %}, contributors.
Released under the {%= license.type %} license

Includes

Include other documents, allowing them to be reused across multiple projects, or just to organize:

## Contribute
{%= docs("contributing") %}

That's it! (More docs are on the way.) See this gist for a more detailed example.

Customize Verb

Verb is easy to extend, here are some examples (verb-cli will automatically use these):

example verbfile, with custom src, dest and metadata.
example verbfile with logging
example .verbrc.yml

Install

Install with npm:

npm i verb --save-dev

Be sure to install Verb locally in projects that use Verb.

Other tools

Get grunt-verb to automate Verb in your Grunt tool-chains
Get gulp-verb to automate Verb in your gulp tool-chains

Author

Jon Schlinkert

License

This file was generated by Verb on March 23, 2014.