forked from typedoc2md/typedoc-plugin-markdown
/
types.ts
45 lines (41 loc) · 990 Bytes
/
types.ts
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
export interface PluginOptions {
id: string;
docsRoot: string;
out: string;
sidebar: SidebarOptions;
readmeTitle?: string;
globalsTitle?: string;
plugin: string[];
readme?: string;
disableOutputCheck?: boolean;
cleanOutputDir?: boolean;
entryPoints?: string[];
watch: boolean;
hideInPageTOC: boolean;
hideBreadcrumbs: boolean;
hidePageTitle: boolean;
hideMembersSymbol: boolean;
entryDocument: string;
includeExtension?: boolean;
indexSlug?: string;
theme?: string;
frontmatter: FrontMatter;
}
export type FrontMatter =
| Record<string, string | boolean | number | null>
| undefined;
export interface SidebarOptions {
fullNames?: boolean;
categoryLabel: string;
collapsed: boolean;
indexLabel?: string;
readmeLabel?: string;
position: number | null;
autoConfiguration: boolean;
}
export interface SidebarCategory {
type: string;
label: string;
items: SidebarItem[];
}
export type SidebarItem = SidebarCategory | string;