JSPM – gulp-typedoc@1.0.3

Package Exports

gulp-typedoc

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-typedoc) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Synopsis

Gulp plugin to execute the TypeDoc tool by Sebastian Lenz (https://sebastian-lenz.github.io/typedoc)

Installation

You do not need to install typedoc separately, just install gulp-typedoc:

npm install --save-dev gulp-typedoc

Usage

The plugin takes an object, of which all properties are passed transparently to the typedoc executable. Pipe in TypeScript files. The documentation files are not piped out, this is a future extension.

Code Example

var typedoc = require("gulp-typedoc");

gulp.task("typedoc", function() {
    return gulp
        .src(["data/*.ts"])
        .pipe(typedoc({ 
            module: "commonjs", 
            out: "./out", 
            name: "my-project", 
            target: "es5"
        }))
    ;
});

Contributors

Rogier Schouten rogier.schouten@gmail.com

License

Apache-2.0