/
typedoc.js
52 lines (49 loc) · 1.34 KB
/
typedoc.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
const isProdSite = process.env.NODE_ENV === 'production';
/**
* typedoc 配置项
* 快查地址: https://typedoc.org/guides/options/
*/
module.exports = {
name: 'umi-plugin-extensions',
// mode: 'file',
tsconfig: './tsconfig-typedoc.json',
entryPoints: ['types/index.d.ts'],
// includes: ['src/types'],
out: 'document/docs/api',
exclude: ['**/node_modules/**'],
// externalPattern: [''],
excludePrivate: true,
excludeProtected: true,
// excludeExternals: true,
// excludeNotExported: true,
/**
* 如果注释里包含 @category
* 设为 false 则按照 category 分组显示
* 否则按照 class interface 等默认分组显示
*/
// categorizeByGroup: false,
includeVersion: true,
/**
* 不显示源码来源
* 作为文档查阅的过程中这个信息比较干扰
*/
disableSources: true,
// 标记有 @internal 的代码将不会输出
// stripInternal: true,
// plugin: 'none',
plugin: [
// 'typedoc-plugin-external-module-map',
'typedoc-plugin-markdown',
],
// 'external-modulemap': './types/([\\w\\-_]+)/',
// hideBreadcrumbs: true,
readme: 'document/API.md',
entryDocument: 'index.md',
hideBreadcrumbs: true,
namedAnchors: true,
publicPath: '/api/',
// 生成文件名用 - 隔开
filenameSeparator: '-',
// 不生成 navigation 的索引
hideInPageTOC: true,
};