-
Notifications
You must be signed in to change notification settings - Fork 180
/
typedoc.json
63 lines (60 loc) · 1.79 KB
/
typedoc.json
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
53
54
55
56
57
58
59
60
61
62
63
{
"$schema": "https://typedoc-plugin-markdown.org/schema.json",
// typedoc options
"name": "Developer Guide",
"out": "./devguide",
"entryPoints": [
"./packages/typedoc-plugin-markdown",
"./packages/typedoc-plugin-frontmatter",
"./packages/typedoc-plugin-remark",
"./packages/typedoc-github-wiki-theme",
"./packages/typedoc-gitlab-wiki-theme",
"./packages/typedoc-vitepress-theme",
"./packages/docusaurus-plugin-typedoc"
],
"plugin": [
"./packages/typedoc-plugin-markdown/dist/index.js",
"./packages/typedoc-plugin-remark/dist/index.js",
"./devtools/typedoc-plugins/typedoc-default-values.mjs",
"./devtools/typedoc-plugins/typedoc-symbols.mjs"
],
"entryPointStrategy": "packages",
"excludePrivate": false,
"readme": "./packages/README.md",
"packageOptions": {
"includeVersion": false,
"excludePrivate": false,
"readme": "./OVERVIEW.md",
"sortEntryPoints": false,
"sort": "source-order",
"excludeExternals": true,
"gitRevision": "main"
},
// typedoc-plugin-markdown options
"mergeReadme": true,
"outputFileStrategy": "members",
"membersWithOwnFile": ["Class", "Interface", "TypeAlias", "Enum"],
"hidePageHeader": true,
"hideGroupHeadings": true,
"pageTitleTemplates": {
"index": "API Index"
},
"expandObjects": false,
"useCodeBlocks": false,
"parametersFormat": "table",
"enumMembersFormat": "table",
"typeDeclarationFormat": "table",
"indexFormat": "table",
"tableColumnSettings": { "hideSources": true },
"sanitizeComments": true,
"remarkPlugins": [
[
"remark-toc",
{
"tight": true,
"maxDepth": 4,
"skip": "Default Value|Defined in|Example|Overrides|Parameters|Returns|See|Type declaration|Inherited from|Deprecated|Packages|Modules"
}
]
]
}