verb/lib/tags/contrib.js

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

/**
 * Verb <https://github.com/assemble/verb>
 * Generate markdown documentation for GitHub projects.
 *
 * Copyright (c) 2014 Jon Schlinkert, Brian Woodward, contributors.
 * Licensed under the MIT license.
 */

'use strict';

var file = require('fs-utils');
var matter = require('gray-matter');
var contrib = require('verb-contrib-templates');
var _ = require('lodash');

module.exports = function (verb) {
  var verbOpts = verb.options || {};
  var utils = verb.utils;

  exports.contrib = function (name, options) {
    options = _.extend(verbOpts, options || {});

    var files = file.match(name + '.md', contrib, {
      matchBase: true
    });

    var output = files.map(function (filepath) {

      // Parse front matter in the file
      var page = matter.read(filepath);

      var context = _.extend(_.cloneDeep(verb.context), page.context);
      return verb.template(page.content, context);
    }).join(options.sep || '\n');

    return utils.adjust.headings(output);
  };
  return exports;
};