verb

verb

Verb makes it dead simple to generate markdown documentation, using simple templates, with zero configuration required. A project without documentation is like a project that doesn't exist.

Install

Install globally with npm:

npm i -g verb

Usage

Visit the documentation for a full overview of Verb's capabilities, as well as:

.verb.md

For basic docs, like a README, just drop a .verb.md in the root of your project. Then, to build the README just run verb in the command line.

verbfile.js

If you want to create more than a README, you can optionally add a verbfile.js.

var verb = require('verb');

// load data to pass to templates.
verb.data('docs/*.json');
verb.data({author: 'Jon Schlinkert'});

verb

verb.task('default', function() {
  verb.src('.verb.md')
    .pipe(verb.dest('./'));
});

In addition to all of Verb's unique features, Verb can also run any gulp plugin.

API

In adition to the following, all methods from Template are expose on verb.

Verb

Create an instance of Verb with the given options.

• options {Object}

var verb = new Verb();

.task

Define a Verb task.

• name {String}
• fn {Function}

verb.task('docs', function() {
  // do stuff
});

.run

Run an array of tasks.

• tasks {Array}

verb.run(['foo', 'bar']);

.src

Glob patterns or filepaths to source files.

• glob {String|Array}
• options {Object}

verb.task('site', function() {
  verb.src('src/*.hbs', {layout: 'default'})
    verb.dest('dist')
});

.dest

Specify a destination for processed files.

• patterns {String|Array|Function}: Glob patterns, file paths, or renaming function.
• opts {Object}: Options to be passed to dest plugins.

verb.task('sitemap', function() {
  verb.src('src/*.txt')
    verb.dest('dist', {ext: '.xml'})
});

.watch

Rerun the specified task when a file changes.

• glob {String|Array}: Filepaths or glob patterns.
• options {String}
• fn {Function}: Task(s) to watch.

verb.task('watch', function() {
  verb.watch('docs/*.md', ['docs']);
});

Run tests

npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert Copyright (c) 2014 Fractal [e-mail] Released under the MIT license

---

This file was generated by verb on November 11, 2014.