Skip to content
Gulp plugin for the typedoc TypeScript documentation tool.
Branch: master
Clone or download
Pull request Compare This branch is 2 commits ahead, 34 commits behind rogierschouten:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.gitignore
LICENSE
README.md
index.js
package.json

README.md

Gulp-TypeDoc

NPM version

NPM NPM

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 typedoc. Pipe in TypeScript files. The documentation files are not piped out.

Code Example

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

gulp.task("typedoc", function() {
	return gulp
		.src(["data/*.ts"])
		.pipe(typedoc({ 
			// TypeScript options (see typescript docs)
			module: "commonjs", 
			target: "es5",
			includeDeclarations: true,
			
			// Output options (see typedoc docs)
			out: "./out", 
			json: "output/to/file.json",

			// TypeDoc options (see typedoc docs)
			name: "my-project", 
			theme: "/path/to/my/theme",
			plugins: ["my", "plugins"],
			ignoreCompilerErrors: false,
			version: true,
		}))
	;
});

Changelog

1.2.0

Don't start a child process anymore. FIX: having many .ts files no longer causes "command line too long" error.

1.1.0

Allow specifying boolean arguments for typedoc; Replace module "gulp-clean" by "del"

1.0.6

Moved to typedoc version 0.2.x

1.0.5

Moved to typedoc version 0.1.x

1.0.3

Use require.resolve() to find typedoc more reliably

1.0.2

Allow any typedoc version 0.0.x

Contributors

License

Apache-2.0

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.