Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
gulp-typedoc
Advanced tools
Readme
Gulp plugin to execute the TypeDoc tool by Sebastian Lenz http://typedoc.org https://github.com/TypeStrong/typedoc
Install both gulp-typedoc and 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.
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.
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,
}))
;
});
>=0.20.34
now (and supports it)logger
option.ISC
FAQs
Gulp plugin for the TypeDoc typescript documentation tool.
The npm package gulp-typedoc receives a total of 3,575 weekly downloads. As such, gulp-typedoc popularity was classified as popular.
We found that gulp-typedoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.