Gulp plugin for the TypeDoc typescript documentation tool.
npm install gulp-typedoc
npm install --save-dev gulp-typedoc typedoc
`
The reason for installing typedoc separately is that it allows you to choose the version of typedoc, independent from the version of 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.
By default, the plugin will output log messages from TypeDoc. Specify logger: 'none' to suppress TypeDoc logging altogether.
Code Example
`javascript
var typedoc = require("gulp-typedoc");
gulp.task("typedoc", function() {
return gulp
.src(["data/*.ts"])
.pipe(typedoc({
// Output options (see TypeDoc docs http://typedoc.org/api/interfaces/typedocoptionmap.html)
// NOTE: the out option and the json option cannot share the same directory
out: "./out/html/",
json: "/out/file.json",
// TypeDoc options (see TypeDoc docs http://typedoc.org/api/interfaces/typedocoptionmap.html)
name: "my-project",
theme: "/path/to/my/theme",
plugin: ["my", "plugins"],
version: true,
}))
;
});
`
Changelog
$3
* Fix #44 Work with clean copy of user options. Thanks @tristan00b!
$3
* Fix #40 entrypoints not specified to TypeDoc by @robinprashanth
$3
* BREAKING: Requires Typedoc version >=0.20.34 now (and supports it)
* BREAKING: since the options follow the TypeDoc options, these are different now.
* Upgrade dependencies to fix security vulnerabilities
$3
* Upgrade dependencies to fix security vulnerabilities
$3
* Upgrade dependencies to fix security vulnerabilities
$3
* Remove superfluous files from published package
$3
* Upgrade dependencies to fix security vulnerabilities
$3
* Upgrade dependencies to fix security vulnerabilities
$3
* Support typedoc 0.16.1+
$3
* Fix security vulnerabilities in dependencies
$3
* Fix security vulnerabilities in dependencies
$3
* Fix event-stream dependency to 3.3.4 because 3.3.5-3.3.6 have issues.
$3
* Fixed security issue in dependency
* Add TypeScript type definitions
$3
* Removed deprecated gulp-util dependency
$3
* Don't depend on typedoc in package.json dependencies (bugfix by @MattiasBuelens)
$3
* Add support for logger` option.