Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    gulp-codpublic

    gulp-cod Build Status Module Version Dependency Status

    gulp plugin for cod

    usage

    var gulp = require('gulp'),
        cod = require('gulp-cod');
     
    gulp.task('cod', function () {
      gulp.src('src/*.js')
      .pipe(cod())
      .pipe(gulp.dest('./docs'));
    });
    var gulp = require('gulp'),
        cod = require('gulp-cod');
     
    gulp.task('cod', function () {
      gulp.src('src/*.coffee')
      .pipe(cod({
        docBegin: '###*',
        docEnd: '###',
        pretty: false
      }))
      .pipe(gulp.dest('./docs'));
    });

    A .json file will be created for each input source file.

    If you want to combine multiple input files into a single API doc file, use gulp-concat:

    var gulp = require('gulp'),
        concat = require('gulp-concat'),
        cod = require('gulp-cod');
     
    gulp.task('cod', function () {
      gulp.src('src/*.js')
      .pipe(concat('all.js'))
      .pipe(cod())
      .pipe(gulp.dest('./docs'));
    });

    install

    npm install gulp-cod --save

    license

    MIT


    Analytics

    install

    npm i gulp-cod

    Downloadsweekly downloads

    0

    version

    0.1.3

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar