gulp-wrap-docco

A gulp plugin to convert code into html using docco's parser, marked, highlight.js and lodash.template

Usage

First, install gulp-wrap-docco as a development dependency:

npm install --save-dev gulp-wrap-docco

Then, add it to your gulpfile.js:

var wrapDocco = require('gulp-wrap-docco');
 
gulp.task('wrapDocco', function(){
  gulp.src(...)
  	.pipe(wrapDocco({src: 'template.html'}));
    .pipe(gulp.dest(...));
});

API

gulp-wrap-docco is a function(options) that returns a read-write stream.

Options

type: either string or {src: string}

if options is a string than it is interperted as a literal lodash template. Otherwise options.src is expected to contain a path to a file that contains a template.

default: {src: 'lib/default.template.html'}