输入选项
| 名称 | 说明 |
|---|---|
| entryPoints | 这个选项用于指定Typedoc生成的文档的入口点。入口点是指被文档化的对象的定义所在的文件或模块。通过指定入口点，Typedoc可以找到被文档化的对象，并生成相应的文档。这个选项可以接受一个字符串或字符串数组，用于指定一个或多个入口文件的路径 |
| entryPointStrategy | 指定处理入口点的策略，入口点是指被文档化的对象的定义所在的文件或模块。TypeDoc通过检查这些文件的导出并根据这些导出创建文档 |
| exclude | 用于指定应该从编译过程中排除的文件或文件夹。这意味着，当Typedoc处理TypeScript源代码时，它将忽略这些指定的文件或文件夹，不会将它们包含在生成的文档中。 |
| externalPattern | 用于指定用于识别外部模块的正则表达式模式。默认情况下，它会把项目中所有导入的模块都视为内部模块，并生成相应的文档。但是，有些模块可能是从外部引入的，并不需要生成文档。这时，就可以使用externalPattern选项来指定哪些模块应该被视为外部模块，不包含在生成的文档中 |
| excludeExternals | 用于指定是否排除外部模块，excludeExternals选项可以设置为true或false |
| excludeNotDocumented | excludeNotDocumented选项可以设置为true或false。如果设置为true，Typedoc将只记录具有文档注释的符号，而忽略其他未注释的符号。如果设置为false或未设置该选项，Typedoc会记录所有解析出来的符号，包括未注释的符号 |
| excludeInternal | 用于指定是否排除内部模块，excludeInternal选项可以设置为true或false。如果设置为true，Typedoc将排除所有内部模块，只生成可公开访问的模块的文档。如果设置为false或未设置该选项，Typedoc会将所有可导出的模块都包含在生成的文档中。 |
| excludePrivate | 用于指定是否排除私有成员，excludePrivate选项可以设置为true或false。如果设置为true，Typedoc将排除所有私有成员，只生成非私有成员的文档。如果设置为false或未设置该选项，Typedoc会将所有解析出来的成员都包含在生成的文档中。 |
| excludeProtected | 用于指定是否排除受保护的成员，excludeProtected选项可以设置为true或false。如果设置为true，Typedoc将排除所有受保护的成员，只生成非受保护成员的文档。如果设置为false或未设置该选项，Typedoc会将所有解析出来的成员都包含在生成的文档中 |
| media | 注入多媒体文件地址 |
| includes | 当Typedoc生成文档时，它会查找指定的文件或文件夹，并将这些文件或文件夹包含在生成的文档中，注入其他文档地址, 例如 markdown 文件 |
输出选项
| 名称 | 说明 |
|---|---|
| out | 文档输出目录 |
| json | Typedoc可以生成一个JSON文件，其中包含了TypeScript源代码中的注释和元数据，以及与它们相关联的文档信息。这个JSON文件可以被其他工具读取和使用，以进一步处理和展示文档 |
| pretty | 用于指定是否为生成的文档添加格式化和美化 |
| emit | 当设置为true时，"emit"选项将使Typedoc生成文档并输出到指定的输出格式（如HTML、JSON等）。如果设置为false，Typedoc将不会生成任何输出文件，但仍然会执行文档解析和生成过程。 |
| theme | default,minimal,path |
| customCss | 支持通过CSS来自定义文档的外观和样式。在TypeDoc中，可以使用自定义CSS文件来覆盖默认的样式，并按照自己的需要进行定制 |
| markedOptions | 用于指定传递给Marked库的选项。Marked库是一个用于将Markdown文本转换为HTML的JavaScript库，TypeDoc使用它来将注释解析为HTML文档。 |
| name | 名称 |
| includeVersion | 是否包含版本号 |
| disableSources | 用于指定是否禁用源代码映射（source map）的生成 |
| basePath | 指定用于显示文件路径的基本路径。如果未设置，TypeDoc将通过取所有源文件的最低公共目录进行猜测。 |
| excludeTags | 指定在解析文档注释时应从中移除的标记。如果你的项目使用apiDoc来记录RESTful Web API，这个功能很有用。 |
| readme | readme文本路径或None |
| cname | 创建一个CNAME文件在指定的输出目录，并填写指定的文本 |
| htmlLang | 在TypeDoc的HTML输出中设置lang属性，默认为en，结果为＜html lang＝“en”＞。 |
| hideGenerator | 不要在页面末尾打印 TypeDoc 链接。默认为 false。 |
| searchInComments | 在生成的文档站点中启用搜索注释文本的功能。注意：启用此选项将增加您的搜索索引的大小，在有很多长评论的项目中可能会增加一个数量级的大小 |
注释选项
| 名称 | 说明 |
|---|---|
| commentStyle | 确定 TypeDoc 将使用的注释类型。 |
| blockTags | 覆盖 TypeDoc 的支持块标记，对任何未在此处列出的标记发出警告。 |
组织选项
| 名称 | 说明 |
|---|---|
| categorizeByGroup | 此标志按组（在属性、方法等内部）对反射进行分类。要将同一类别的属性和方法分组在一起，请将此标志设置为false。默认为true。 |
| defaultCategory | 为默认类别设置名称，当页面中的某些元素被分类时使用该默认类别。默认值为“其他” |
| categoryOrder | 这个数组选项允许覆盖类别在中的显示顺序。一个由 * 组成的字符串表示不在列表中的类别应该出现在哪里。默认情况下，类别按字母顺序显示。如果发现未知类别，它们将默认列在最后。 |
| sort | 显示排序 |
通用配置
| 名称 | 说明 |
|---|---|
| watch | 监视源文件更改 |
| preserveWatchOutput | 默认情况下，–watch在编译步骤之间清除屏幕。如果指定了–preserveWatchOutput，则禁用此行为。 |