UNPKG

1.36 kBTypeScriptView Raw
1export interface Heading {
2 depth: number;
3 slug: string;
4 value: string;
5}
6export interface Entry {
7 id: string;
8 filepath: string;
9 slug: string;
10 route: string;
11 name: string;
12 order: number;
13 menu: string | null;
14 headings: Heading[];
15 [key: string]: any;
16}
17export interface MenuItem {
18 id: string;
19 name: string;
20 route?: string;
21 href?: string;
22 menu?: MenuItem[];
23 order?: number;
24 parent?: string;
25 [key: string]: any;
26}
27export declare type ThemeConfig = Record<string, any>;
28export interface Config {
29 title: string;
30 description: string;
31 themeConfig: ThemeConfig;
32 menu: MenuItem[];
33 version: string | null;
34 repository: string | null;
35 native: boolean;
36 separator: string;
37 base?: string;
38}
39export declare type Entries = {
40 key: string;
41 value: Entry;
42}[];
43export declare type Props = {
44 key: string;
45 value: any;
46}[];
47export declare type TransformFn = (config: ThemeConfig) => ThemeConfig;
48export interface Database {
49 config: Config;
50 currentEntry: Entry;
51 props?: Props;
52 entries?: Entries;
53}
54export interface DoczState extends Database {
55 themeConfig?: ThemeConfig;
56 transform?: TransformFn;
57}
58export declare const doczState: import("./utils/createState").State<DoczState>;