gulp-compodoc
Compodoc plugin for gulp
The missing documentation tool for your Angular application
Install
$ npm install --save-dev @compodoc/gulp-compodoc
Usage
const gulp = require('gulp'),
compodoc = require('@compodoc/gulp-compodoc');
gulp.task('default', () => {
return gulp.src('src/**/*.ts').pipe(
compodoc({
output: 'documentation',
tsconfig: 'src/tsconfig.json',
serve: true
})
);
});
API
compodoc(options)
options
All options from compodoc are available. The list is available here.
License
Everything in this repo is MIT License unless otherwise specified.
MIT © 2016 - Vincent Ogloblinsky
关于 @compodoc/gulp-compodoc 的常见问题
@compodoc/gulp-compodoc 是什么？
Compodoc plugin for gulp
如何安装 @compodoc/gulp-compodoc？
在项目目录运行 npm install @compodoc/gulp-compodoc，或使用 pnpm add / yarn add / bun add。
@compodoc/gulp-compodoc 支持 TypeScript 吗？
该包的 package.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/compodoc__gulp-compodoc 是否存在。
@compodoc/gulp-compodoc 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@compodoc/gulp-compodoc 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=5.10.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@compodoc/gulp-compodoc 可以商用吗？
@compodoc/gulp-compodoc 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@compodoc/gulp-compodoc 的下载量有多少？
根据 npm 官方下载统计，@compodoc/gulp-compodoc 在 2026/10/11 – 2026/11/09 这 30 天内被下载 4,280 次，日均约 143 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@compodoc/gulp-compodoc 还在维护吗？
最新版本 0.0.10 发布于 2018/11/28（7 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/01/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。