-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathtypedoc.config.mjs
More file actions
33 lines (28 loc) · 908 Bytes
/
typedoc.config.mjs
File metadata and controls
33 lines (28 loc) · 908 Bytes
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
import packageJson from "./package.json" with { type: "json" };
/** @type {Partial<import("typedoc").TypeDocOptions>} */
export default {
// Output configuration
outputFileStrategy: "modules",
cleanOutputDir: false,
entryFileName: "REFERENCE.md",
readme: "none",
exclude: ["**/node_modules/**"],
gitRevision: `v${packageJson.version.replace(/-\w+$/, "")}`,
mergeModulesMergeMode: "project",
// Content organization
groupOrder: ["Functions", "*"],
excludeNotDocumented: true,
excludeInternal: true,
// Formatting options
parametersFormat: "table",
interfacePropertiesFormat: "table",
indexFormat: "table",
enumMembersFormat: "table",
typeDeclarationFormat: "table",
// Display options
hideBreadcrumbs: true,
hidePageHeader: true,
hidePageTitle: true,
// Plugins
plugin: ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules", "typedoc-plugin-zod"],
};