gulp-typedoc

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"
		}))
	;
});

Changelog

1.0.3

Use require.resolve() to find typedoc more reliably

1.0.2

Allow any typedoc version >= 0.0.4

Contributors

• Rogier Schouten [e-mail]
• Daan Wissing [e-mail]

License

Apache-2.0