在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):rogierschouten/gulp-typedoc开源软件地址(OpenSource Url):https://github.com/rogierschouten/gulp-typedoc开源编程语言(OpenSource Language):JavaScript 87.6%开源软件介绍(OpenSource Introduction):Gulp-TypeDocSynopsisGulp plugin to execute the TypeDoc tool by Sebastian Lenz http://typedoc.org https://github.com/TypeStrong/typedoc InstallationInstall both gulp-typedoc and 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. UsageThe 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 Code Examplevar 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,
}))
;
}); Changelog3.0.2
3.0.1
3.0.0
2.2.9
2.2.8
2.2.7
2.2.6
2.2.5
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.2
2.1.1
2.1.0
2.0.3
2.0.2
2.0.1
2.0.0
1.2.0
1.1.0
1.0.6
1.0.5
1.0.3
1.0.2
Contributors
LicenseISC |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论