-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtypedoc.config.mjs
34 lines (33 loc) · 1.05 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
// @ts-check
/** @type {import('typedoc').TypeDocOptions & import('typedoc-plugin-markdown').PluginOptions & { docsRoot?: string } } */
export default {
/**
* typedoc options
* ref: https://typedoc.org/documents/Options.html
*/
entryPoints: ['./src/index.ts', './src/definition.ts', './src/generator.ts', './src/renderer.ts'],
out: 'docs/api',
plugin: ['typedoc-plugin-markdown', 'typedoc-vitepress-theme'],
readme: 'none',
groupOrder: ['Variables', 'Functions', 'Class'],
/**
* typedoc-plugin-markdown options
* ref: https://typedoc-plugin-markdown.org/docs/options
*/
entryFileName: 'index',
hidePageTitle: false,
useCodeBlocks: true,
disableSources: true,
indexFormat: 'table',
parametersFormat: 'table',
interfacePropertiesFormat: 'table',
classPropertiesFormat: 'table',
propertyMembersFormat: 'table',
typeAliasPropertiesFormat: 'table',
enumMembersFormat: 'table',
/**
* typedoc-vitepress-theme options
* ref: https://typedoc-plugin-markdown.org/plugins/vitepress/options
*/
docsRoot: './docs'
}