| -h, --help |
输出使用信息 |
| -V, --version |
输出版本号 |
| -c, --config [config] |
配置文件: .compodocrc, .compodocrc.json, .compodocrc.yaml or compodoc property in package.json 属性 |
| -p, --tsconfig [config] |
tsconfig.json 文件 |
| -d, --output [folder] |
在哪里存储生成的文档 |
| -y, --extTheme [file] |
外部造型主题 |
| -n, --name [name] |
文档名称 |
| -a, --assetsFolder [folder] |
在生成的文档文件夹中复制的外部资产文件夹 |
| -o, --open |
打开生成的文档 |
| -t, --silent |
在静默模式下，日志消息不会记录在控制台中 |
| -s, --serve |
服务生成的文档(默认为 http://localhost:8080/) |
| -r, --port [port] |
更改默认服务端口 |
| -w, --watch |
在服务和强制文档重建后，观察源文件 |
| -e, --exportFormat [format] |
导出指定格式(json, html(默认)) |
| --language [language] |
用于生成文档的语言 (de-DE, en-US, es-ES, fr-FR, hu-HU, it-IT, ja-JP, ko-KR, nl-NL, pl-PL, pt-BR, sk-SK, zh-CN) (默认: en-US) |
| --theme [theme] |
选择一个可用的主题，默认为 'gitbook' (laravel, original, material, postmark, readthedocs, stripe, vagrant) |
| --hideGenerator |
不要在页面底部打印 Compodoc 标志 |
| --toggleMenuItems |
关闭菜单(default ['all'])值中的默认项: ['all'] 或者是 ['modules','components','directives','controllers','classes','injectables','guards','interfaces','interceptors','pipes','miscellaneous','additionalPages']其中一个) |
| --navTabConfig |
用两个字符串属性按所需顺序列出导航选项卡对象 ("id" 和 "label"). 双引号必须用'\'转义。 可用的选项卡 IDs 是 "info", "readme", "source", "templateData", "tree", 和 "example". 注意:某些选项卡只会在适用于给定依赖项时显示 |
| --templates [folder] |
Handlebars 模板覆盖内置模板的目录路径 |
| --includes [path] |
要包含的外部标记文件的路径 |
| --includesName [name] |
外部标记文件的项目菜单名称 (默认是 "Additional documentation") |
| --coverageTest |
使用阈值(默认 70)测试文档覆盖率的命令 |
| --coverageMinimumPerFile [minimum] |
每个文件的文档覆盖率测试命令的最小值(默认为 0) |
| --coverageTestThresholdFail [boolean] |
文档覆盖的测试命令(全局的或每个文件的)将会失败并产生错误或者只是警告用户(true: error, false: warn)(默认值:true) |
| --coverageTestShowOnlyFailed |
只显示覆盖率测试失败的文件 |
| --unitTestCoverage [json-summary] |
要包含单元测试覆盖率，请指定 istanbul JSON 覆盖率摘要文件 |
| --disableSourceCode |
不添加源代码选项卡和到源代码的链接 |
| --disableDomTree |
不添加 dom 树标签 |
| --disableTemplateTab |
不添加模板选项卡 |
| --disableStyleTab |
不添加样式标签 |
| --disableGraph |
禁用依赖关系图的呈现 |
| --disableCoverage |
不添加文档覆盖率报告 |
| --disablePrivate |
在生成的文档中不显示私有 |
| --disableProtected |
在生成的文档中不显示受保护 |
| --disableInternal |
在生成的文档中不显示@internal |
| --disableLifeCycleHooks |
没有在生成的文档中显示 Angular 的生命周期钩子 |
| --disableRoutesGraph |
不添加路由图 |
| --disableSearch |
不添加搜索输入 |
| --disableDependencies |
不添加依赖项列表 |
| --minimal |
只有文档的最小模式。没有搜索，没有图表，没有覆盖范围。 |
| --customFavicon [path] |
使用自定义图标 |
| --customLogo [path] |
使用自定义 logo |
| --gaID [id] |
谷歌分析跟踪 ID |
| --gaSite [site] |
谷歌分析站点名称(默认: auto) |