-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathtypedoc.config.mjs
43 lines (43 loc) · 1.15 KB
/
typedoc.config.mjs
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
/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-merge-modules').Config & import('typedoc-plugin-markdown').PluginOptions} */
export default {
name: 'Cheshire Cat',
entryPoints: ['./src'],
entryPointStrategy: 'expand',
tsconfig: 'tsconfig.json',
plugin: [
'typedoc-vitepress-theme',
'typedoc-plugin-markdown',
'typedoc-plugin-merge-modules',
'typedoc-plugin-coverage',
],
readme: 'none',
indexFormat: 'table',
parametersFormat: 'table',
propertiesFormat: 'table',
enumMembersFormat: 'table',
propertyMembersFormat: 'table',
classPropertiesFormat: 'table',
typeDeclarationFormat: 'table',
interfacePropertiesFormat: 'table',
githubPages: false,
useCodeBlocks: false,
disableSources: true,
excludePrivate: true,
categorizeByGroup: false,
hidePageHeader: true,
exclude: ['**/node_modules/**/*', '**/test/**/*', '**/*.txt'],
out: './docs/api',
docsRoot: './docs',
textContentMappings: {
'title.indexPage': 'API Reference',
'title.memberPage': '{name}',
'breadcrumbs.home': 'Overview',
},
coverageLabel: 'Coverage',
sidebar: {
autoConfiguration: true,
format: 'vitepress',
pretty: true,
collapsed: true,
},
}