如何默认关闭模块层级?能否通过参数添加自定义JS至index.html?
问题解答
1. 模块层级默认关闭的配置实现
可以通过文档工具的配置实现,以常用的TypeDoc为例:
- 在配置文件(如
typedoc.json)中添加:{ "collapseAllReflections": true } - 或者直接用命令行参数:
typedoc --collapseAllReflections
如果是其他文档生成工具,可查找对应“默认折叠模块层级”的配置项(比如ESDoc的"collapse": true),核心是启用折叠开关即可。
2. 为生成的index.html添加自定义JavaScript
多数文档工具支持通过配置或命令行注入自定义脚本:
- 以TypeDoc为例,使用
--htmlInjectScripts参数指定脚本路径:
也可在配置文件中持久化设置:typedoc --htmlInjectScripts ./path/to/your-custom-script.js{ "htmlInjectScripts": ["./path/to/your-custom-script.js"] } - 若工具支持自定义模板,还可以直接修改模板文件,在
<head>或<body>末尾插入<script>标签引入你的代码。
3. --lib=<dir>参数的用法
这个参数常见于TypeDoc这类文档生成工具,作用是指定额外的模块目录,将该目录下的代码纳入文档生成范围:
- 在多包项目中,如果你想把某个子包的文档合并到主文档里,可执行:
typedoc --lib ./packages/utils - 它会让工具扫描指定目录下的源文件,生成对应的文档内容,常用于整合多包项目的跨模块文档。
内容的提问来源于stack exchange,提问作者Cigarette Smoking Man
相关产品推荐
相关产品推荐

