verb/lib/middleware/examples.js

Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used on hundreds of projects of all sizes to generate everything from API docs to readmes.

'use strict';

var extract = require('gfm-code-blocks');

/**
 * Detect the layout to use
 */

module.exports = function (app) {
  return function (file, next) {
    app.cache.data.examples = app.cache.data.examples || {};
    var examples = {};

    var str = file.content;
    extract(str).forEach(function (block) {
      block.orig = block.block;
      var m = /^\/\/\s*example\.([^\n]+)([\s\S]+)/.exec(block.code);
      if (!m) return next();
      var name = m[1];
      examples[name] = examples[name] || [];
      file.content = file.content.split(block.block).join('');
      block.block = '```js\n' + m[2] + '\n```\n';
      examples[name].push(block);
    });

    app.cache.data.examples = examples;
    next();
  };
};