gulp-codo

1.0.4 • Public • Published

gulp-codo

Gulp plug-in to generate documentation with codo.

Build Status npm version Dependency Status Development Dependency Status

Install:

First install codo globally:

$ npm install -g codo

Then:

$ npm install --save-dev gulp-codo
Usage:
var gulp = require('gulp'),
    codo = require('gulp-codo');
 
gulp.task('doc', function () {
    return gulp.src('*.coffee', {read: false})
    .pipe(codo({
        name: 'Greeter',
        title: 'Greeter documentation',
        readme: 'greeter.md',
        extra: 'LICENSE.md'
    }));
});
Options:
  • options: Object : Object containing any of the following options:
    • name: string : Project name for generated documenation (e.g. Greeter).
    • title: string : Title for generated documentation (e.g. Greeter documentation).
    • readme: string: : Readme to use for generated documentation (e.g. greeter.md).
    • dir: string : Output directory for documentation (e.g. ./doc).
      • theme: string : The theme to be used (e.g. default).
      • undocumented: boolean : List undocumented objects
      • closure: boolean : Try to parse closure-like block comments
      • private: boolean : Show privates
      • verbose: boolean : Show parsing errors
      • extra: string or Array : Add extra files (e.g. ['LICENSE.md'])
Authors
License

MIT

Package Sidebar

Install

npm i gulp-codo

Weekly Downloads

6

Version

1.0.4

License

MIT

Last publish

Collaborators

  • hildjj
  • stpettersens