1.8.0 • Published 10 years ago

gulp-doxme v1.8.0

Weekly downloads
1
License
MIT
Repository
github
Last release
10 years ago

Build statusCode climateDavid DM

gulp-doxme

Create markdown from dox-ish output.

A gulp plugin for doxme.

Installation

$ npm install gulp-doxme

Usage

Read through doxme to see what happens under the hood and learn about the available options.

With gulp-dox

This approach is quick and simple.

Takes a JSON file as input (such as that coming from gulp-dox).

var gulp = require("gulp");
var dox = require("gulp-dox");
var doxme = require("gulp-doxme");
var concat = require("gulp-concat");

gulp.src("*.js")
  .pipe(dox())
  .pipe(doxme())
  .pipe(concat("Readme.md"))
  .pipe(gulp.dest("."))
  ;

With gulp-data

This approach gives you more power. Among other things it allows you to process output from dox before passing it to gulp-doxme.

Takes file.data as input (for example coming from gulp-data):

var gulp = require("gulp");
var dox = require("dox");
var data = require("gulp-data");
var doxme = require("gulp-doxme");
var concat = require("gulp-concat");

gulp.src("*.js")
  .pipe(data(function (file) {
    return dox.parseComments(file.contents.toString());
    }))
  .pipe(doxme())
  .pipe(concat("Readme.md"))
  .pipe(gulp.dest("."))
  ;

Passing options

The options readme, package and travis are passed to doxme:

//...
  .pipe(doxme(
    { readme: true
    , package: {/*...*/}
    , travis: true
    }))

License

MIT © Tomek Wiszniewski.

1.8.0

10 years ago

1.7.0

10 years ago

1.6.1

10 years ago

1.6.0

10 years ago

1.5.7

10 years ago

1.5.6

10 years ago

1.5.5

10 years ago

1.5.4

10 years ago

1.5.3

10 years ago

1.5.2

10 years ago

1.5.1

10 years ago

0.0.0

10 years ago