@mintlify/prebuild 1.0.319 → 1.0.321

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/prebuild/update/ConfigUpdater.d.ts +1880 -2119
  2. package/dist/prebuild/update/ConfigUpdater.js +10 -28
  3. package/dist/prebuild/update/docsConfig/index.d.ts +0 -1931
  4. package/dist/prebuild/update/docsConfig/index.js +1 -5
  5. package/dist/prebuild/update/index.d.ts +1 -0
  6. package/dist/prebuild/update/index.js +1 -0
  7. package/dist/prebuild/update/mintConfig/index.d.ts +0 -242
  8. package/dist/prebuild/update/mintConfig/index.js +4 -7
  9. package/dist/tsconfig.build.tsbuildinfo +1 -1
  10. package/package.json +6 -6
package/dist/prebuild/update/ConfigUpdater.d.ts CHANGED
@@ -1,2185 +1,1946 @@
1
1
  import { ConfigType, MintConfig } from '@mintlify/models';
2
- import { DocsConfig } from '@mintlify/validation';
3
- export declare class ConfigUpdater {
2
+ export declare class ConfigUpdater<T> {
4
3
  private type;
5
- private static instances;
6
- static getInstance(type: ConfigType): ConfigUpdater;
7
- private constructor();
4
+ constructor(type: ConfigType);
8
5
  getConfigType(): "mint" | "docs";
9
- validateMintConfigJson: (configContents: string) => Promise<{
6
+ getConfig(configPath: string): Promise<T>;
7
+ validateConfigJsonString: (configContents: string) => Promise<{
8
+ data: T;
10
9
  warnings: import("zod").ZodIssue[];
11
10
  success: true;
12
- data: {
13
- name: string;
14
- $schema: string;
15
- favicon: string;
16
- colors: {
17
- primary: string;
18
- light?: string | undefined;
19
- dark?: string | undefined;
20
- background?: {
11
+ } | {
12
+ data: T;
13
+ warnings: import("zod").ZodIssue[];
14
+ success: true;
15
+ }>;
16
+ private readConfigFile;
17
+ writeConfigFile: (config: T, targetDir?: string) => Promise<void>;
18
+ private parseConfigJson;
19
+ }
20
+ export declare const MintConfigUpdater: ConfigUpdater<MintConfig>;
21
+ export declare const DocsConfigUpdater: ConfigUpdater<{
22
+ name: string;
23
+ $schema: string;
24
+ theme: "mint";
25
+ colors: {
26
+ primary: string;
27
+ light?: string | undefined;
28
+ dark?: string | undefined;
29
+ };
30
+ navigation: ({
31
+ global?: {
32
+ languages?: ({
33
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
34
+ hidden?: boolean | undefined;
35
+ } & {
36
+ href: string;
37
+ })[] | undefined;
38
+ versions?: ({
39
+ version: string;
40
+ hidden?: boolean | undefined;
41
+ } & {
42
+ href: string;
43
+ })[] | undefined;
44
+ tabs?: ({
45
+ tab: string;
46
+ icon?: string | {
47
+ name: string;
48
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
49
+ } | undefined;
50
+ hidden?: boolean | undefined;
51
+ } & {
52
+ href: string;
53
+ })[] | undefined;
54
+ dropdowns?: ({
55
+ dropdown: string;
56
+ icon?: string | {
57
+ name: string;
58
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
59
+ } | undefined;
60
+ hidden?: boolean | undefined;
61
+ } & {
62
+ href: string;
63
+ })[] | undefined;
64
+ anchors?: ({
65
+ anchor: string;
66
+ icon?: string | {
67
+ name: string;
68
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
69
+ } | undefined;
70
+ color?: {
21
71
  light?: string | undefined;
22
72
  dark?: string | undefined;
23
73
  } | undefined;
24
- anchors?: string | {
25
- from: string;
26
- to: string;
27
- via?: string | undefined;
28
- } | undefined;
29
- ultraLight?: any;
30
- ultraDark?: any;
31
- };
32
- navigation: import("@mintlify/models").NavigationGroup[];
33
- mintlify?: string | undefined;
34
- logo?: string | {
35
- light: string;
36
- dark: string;
37
- href?: string | undefined;
38
- } | undefined;
39
- theme?: "venus" | "quill" | "prism" | undefined;
40
- layout?: "topnav" | "sidenav" | "solidSidenav" | undefined;
41
- openapi?: string | string[] | undefined;
42
- topbar?: {
43
- style?: "gradient" | "default" | undefined;
44
- } | undefined;
45
- sidebar?: {
46
- items?: "container" | "card" | "border" | "undecorated" | undefined;
47
- } | undefined;
48
- rounded?: "default" | "sharp" | undefined;
49
- api?: {
50
- baseUrl?: string | string[] | undefined;
51
- auth?: {
52
- method?: "key" | "bearer" | "basic" | "cobo" | undefined;
53
- name?: string | undefined;
54
- inputPrefix?: string | undefined;
55
- } | undefined;
56
- playground?: {
57
- mode: "show" | "simple" | "hide";
58
- disableProxy?: boolean | undefined;
59
- } | undefined;
60
- request?: {
61
- example?: {
62
- showOptionalParams?: boolean | undefined;
63
- languages?: string[] | undefined;
64
- } | undefined;
65
- } | undefined;
66
- maintainOrder?: boolean | undefined;
67
- paramFields?: {
68
- expanded?: "all" | "topLevel" | "topLevelOneOfs" | "none" | undefined;
69
- } | undefined;
70
- } | undefined;
71
- modeToggle?: {
72
- default?: "light" | "dark" | undefined;
73
- isHidden?: boolean | undefined;
74
- } | undefined;
75
- versions?: (string | {
76
- name: string;
77
- url?: string | undefined;
78
- default?: true | undefined;
79
- locale?: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de" | undefined;
74
+ hidden?: boolean | undefined;
75
+ } & {
76
+ href: string;
80
77
  })[] | undefined;
81
- metadata?: Record<string, string> | undefined;
82
- codeBlock?: {
83
- mode?: "dark" | "auto" | undefined;
84
- } | undefined;
85
- eyebrow?: {
86
- display?: "section" | "breadcrumbs" | undefined;
87
- } | undefined;
88
- topbarCtaButton?: {
89
- name: string;
90
- url: string;
91
- type?: "link" | undefined;
92
- style?: "pill" | "roundedRectangle" | undefined;
93
- arrow?: boolean | undefined;
94
- } | {
95
- type: "github";
96
- url: string;
97
- } | undefined;
98
- topbarLinks?: ({
99
- name: string;
100
- url: string;
101
- type?: "link" | undefined;
102
- style?: "pill" | "roundedRectangle" | undefined;
103
- arrow?: boolean | undefined;
104
- } | {
105
- type: "github";
106
- url: string;
107
- })[] | undefined;
108
- primaryTab?: {
78
+ } | undefined;
79
+ } & ({
80
+ languages: any[];
81
+ } | {
82
+ versions: any[];
83
+ } | {
84
+ tabs: any[];
85
+ } | {
86
+ dropdowns: any[];
87
+ } | {
88
+ anchors: any[];
89
+ } | {
90
+ groups: ({
91
+ group: string;
92
+ icon?: string | {
109
93
  name: string;
110
- isDefaultHidden?: boolean | undefined;
111
- } | undefined;
112
- topAnchor?: {
113
- name: string;
114
- icon?: string | undefined;
115
- iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
116
- } | undefined;
117
- anchors?: {
118
- name: string;
119
- url: string;
120
- icon?: string | undefined;
121
- iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
122
- color?: string | {
123
- from: string;
124
- to: string;
125
- via?: string | undefined;
126
- } | undefined;
127
- isDefaultHidden?: boolean | undefined;
128
- version?: string | undefined;
94
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
95
+ } | undefined;
96
+ hidden?: boolean | undefined;
97
+ root?: string | {
98
+ href: string;
99
+ title: string;
100
+ sidebarTitle?: string | undefined;
101
+ description?: string | undefined;
102
+ api?: string | undefined;
129
103
  openapi?: string | undefined;
130
- }[] | undefined;
131
- tabs?: {
132
- name: string;
133
- url: string;
104
+ contentType?: string | undefined;
105
+ authMethod?: string | undefined;
106
+ auth?: string | undefined;
134
107
  version?: string | undefined;
135
- isDefaultHidden?: boolean | undefined;
136
- openapi?: string | undefined;
137
- }[] | undefined;
138
- footer?: {
139
- socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | {
140
- type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter";
141
- url: string;
142
- }[] | undefined;
143
- links?: {
144
- links: {
145
- url: string;
146
- label: string;
147
- }[];
148
- title?: string | undefined;
149
- }[] | undefined;
150
- } | undefined;
151
- background?: {
152
- style?: "gradient" | "grid" | "windows" | undefined;
153
- } | undefined;
154
- backgroundImage?: string | undefined;
155
- font?: {
156
- family: string;
157
- weight?: number | undefined;
108
+ mode?: string | undefined;
109
+ hideFooterPagination?: boolean | undefined;
110
+ authors?: unknown;
111
+ lastUpdatedDate?: string | undefined;
112
+ createdDate?: string | undefined;
113
+ "openapi-schema"?: string | undefined;
114
+ icon?: string | {
115
+ name: string;
116
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
117
+ } | undefined;
118
+ tag?: string | undefined;
158
119
  url?: string | undefined;
159
- format?: "woff" | "woff2" | undefined;
160
- } | {
161
- headings?: {
162
- family: string;
163
- weight?: number | undefined;
164
- url?: string | undefined;
165
- format?: "woff" | "woff2" | undefined;
166
- } | undefined;
167
- body?: {
168
- family: string;
169
- weight?: number | undefined;
170
- url?: string | undefined;
171
- format?: "woff" | "woff2" | undefined;
172
- } | undefined;
120
+ hideApiMarker?: boolean | undefined;
121
+ noindex?: boolean | undefined;
122
+ isPublic?: boolean | undefined;
173
123
  } | undefined;
174
- feedback?: {
175
- thumbsRating?: boolean | undefined;
176
- suggestEdit?: boolean | undefined;
177
- raiseIssue?: boolean | undefined;
178
- } | undefined;
179
- analytics?: {
180
- amplitude?: {
181
- apiKey: string;
182
- } | undefined;
183
- clearbit?: {
184
- publicApiKey: string;
185
- } | undefined;
186
- fathom?: {
187
- siteId: string;
188
- } | undefined;
189
- ga4?: {
190
- measurementId: string;
191
- } | undefined;
192
- gtm?: {
193
- tagId: string;
194
- } | undefined;
195
- heap?: {
196
- appId: string;
197
- } | undefined;
198
- hotjar?: {
199
- hjid: string;
200
- hjsv: string;
201
- } | undefined;
202
- koala?: {
203
- publicApiKey: string;
204
- } | undefined;
205
- logrocket?: {
206
- appId: string;
207
- } | undefined;
208
- mixpanel?: {
209
- projectToken: string;
210
- } | undefined;
211
- pirsch?: {
212
- id: string;
213
- } | undefined;
214
- posthog?: {
215
- apiKey: string;
216
- apiHost?: string | undefined;
217
- } | undefined;
218
- plausible?: {
219
- domain: string;
220
- server?: string | undefined;
221
- } | undefined;
222
- segment?: {
223
- key: string;
224
- } | undefined;
225
- } | undefined;
226
- integrations?: {
227
- intercom?: string | undefined;
228
- frontchat?: string | undefined;
229
- osano?: string | undefined;
230
- } | undefined;
231
- isWhiteLabeled?: boolean | undefined;
232
- search?: {
233
- prompt?: string | undefined;
234
- location?: "side" | "top" | undefined;
235
- } | undefined;
236
- redirects?: {
124
+ } & ({
125
+ openapi: (string | string[] | {
237
126
  source: string;
238
- destination: string;
239
- permanent?: boolean | undefined;
240
- }[] | undefined;
241
- seo?: {
242
- indexHiddenPages?: boolean | undefined;
243
- } | undefined;
244
- footerSocials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | {
245
- type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter";
246
- url: string;
247
- }[] | undefined;
248
- };
249
- }>;
250
- validateDocsConfigJson: (configContents: string) => Promise<{
251
- warnings: import("zod").ZodIssue[];
252
- success: true;
253
- data: {
254
- name: string;
255
- $schema: string;
256
- theme: "linden";
257
- colors: {
258
- primary: string;
259
- light?: string | undefined;
260
- dark?: string | undefined;
261
- };
262
- navigation: ({
263
- global?: {
264
- languages?: ({
265
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
266
- hidden?: boolean | undefined;
267
- } & {
268
- href: string;
269
- })[] | undefined;
270
- versions?: ({
271
- version: string;
272
- hidden?: boolean | undefined;
273
- } & {
274
- href: string;
275
- })[] | undefined;
276
- tabs?: ({
277
- tab: string;
278
- icon?: string | {
279
- name: string;
280
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
281
- } | undefined;
282
- hidden?: boolean | undefined;
283
- } & {
284
- href: string;
285
- })[] | undefined;
286
- dropdowns?: ({
287
- dropdown: string;
288
- icon?: string | {
289
- name: string;
290
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
291
- } | undefined;
292
- hidden?: boolean | undefined;
293
- } & {
294
- href: string;
295
- })[] | undefined;
296
- anchors?: ({
297
- anchor: string;
298
- icon?: string | {
299
- name: string;
300
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
301
- } | undefined;
302
- color?: {
303
- light?: string | undefined;
304
- dark?: string | undefined;
305
- } | undefined;
306
- hidden?: boolean | undefined;
307
- } & {
308
- href: string;
309
- })[] | undefined;
310
- } | undefined;
311
- } & ({
312
- languages: any[];
313
- } | {
314
- versions: any[];
315
- } | {
316
- tabs: any[];
317
- } | {
318
- dropdowns: any[];
319
- } | {
320
- anchors: any[];
321
- } | {
322
- groups: ({
323
- group: string;
324
- icon?: string | {
325
- name: string;
326
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
327
- } | undefined;
328
- hidden?: boolean | undefined;
329
- root?: string | {
330
- href: string;
331
- title: string;
332
- sidebarTitle?: string | undefined;
333
- description?: string | undefined;
334
- api?: string | undefined;
335
- openapi?: string | undefined;
336
- contentType?: string | undefined;
337
- authMethod?: string | undefined;
338
- auth?: string | undefined;
339
- version?: string | undefined;
340
- mode?: string | undefined;
341
- hideFooterPagination?: boolean | undefined;
342
- authors?: unknown;
343
- lastUpdatedDate?: string | undefined;
344
- createdDate?: string | undefined;
345
- "openapi-schema"?: string | undefined;
346
- icon?: string | {
347
- name: string;
348
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
349
- } | undefined;
350
- tag?: string | undefined;
351
- url?: string | undefined;
352
- hideApiMarker?: boolean | undefined;
353
- noindex?: boolean | undefined;
354
- isPublic?: boolean | undefined;
355
- } | undefined;
356
- } & ({
357
- openapi: (string | string[] | {
358
- source: string;
359
- directory?: string | undefined;
360
- }) & (string | string[] | {
361
- source: string;
362
- directory?: string | undefined;
363
- } | undefined);
364
- } | {
365
- pages: any[];
366
- }))[];
367
- } | {
368
- pages: any[];
369
- })) & (({
370
- global?: {
371
- languages?: ({
372
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
373
- hidden?: boolean | undefined;
374
- } & {
375
- href: string;
376
- })[] | undefined;
377
- versions?: ({
378
- version: string;
379
- hidden?: boolean | undefined;
380
- } & {
381
- href: string;
382
- })[] | undefined;
383
- tabs?: ({
384
- tab: string;
385
- icon?: string | {
386
- name: string;
387
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
388
- } | undefined;
389
- hidden?: boolean | undefined;
390
- } & {
391
- href: string;
392
- })[] | undefined;
393
- dropdowns?: ({
394
- dropdown: string;
395
- icon?: string | {
396
- name: string;
397
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
398
- } | undefined;
399
- hidden?: boolean | undefined;
400
- } & {
401
- href: string;
402
- })[] | undefined;
403
- anchors?: ({
404
- anchor: string;
405
- icon?: string | {
406
- name: string;
407
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
408
- } | undefined;
409
- color?: {
410
- light?: string | undefined;
411
- dark?: string | undefined;
412
- } | undefined;
413
- hidden?: boolean | undefined;
414
- } & {
415
- href: string;
416
- })[] | undefined;
417
- } | undefined;
418
- } & ({
419
- languages: any[];
420
- } | {
421
- versions: any[];
422
- } | {
423
- tabs: any[];
424
- } | {
425
- dropdowns: any[];
426
- } | {
427
- anchors: any[];
428
- } | {
429
- groups: ({
430
- group: string;
431
- icon?: string | {
432
- name: string;
433
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
434
- } | undefined;
435
- hidden?: boolean | undefined;
436
- root?: string | {
437
- href: string;
438
- title: string;
439
- sidebarTitle?: string | undefined;
440
- description?: string | undefined;
441
- api?: string | undefined;
442
- openapi?: string | undefined;
443
- contentType?: string | undefined;
444
- authMethod?: string | undefined;
445
- auth?: string | undefined;
446
- version?: string | undefined;
447
- mode?: string | undefined;
448
- hideFooterPagination?: boolean | undefined;
449
- authors?: unknown;
450
- lastUpdatedDate?: string | undefined;
451
- createdDate?: string | undefined;
452
- "openapi-schema"?: string | undefined;
453
- icon?: string | {
454
- name: string;
455
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
456
- } | undefined;
457
- tag?: string | undefined;
458
- url?: string | undefined;
459
- hideApiMarker?: boolean | undefined;
460
- noindex?: boolean | undefined;
461
- isPublic?: boolean | undefined;
462
- } | undefined;
463
- } & ({
464
- openapi: (string | string[] | {
465
- source: string;
466
- directory?: string | undefined;
467
- }) & (string | string[] | {
468
- source: string;
469
- directory?: string | undefined;
470
- } | undefined);
471
- } | {
472
- pages: any[];
473
- }))[];
474
- } | {
475
- pages: any[];
476
- })) | undefined);
477
- description?: string | undefined;
478
- logo?: string | {
479
- light: string;
480
- dark: string;
481
- href?: string | undefined;
482
- } | undefined;
483
- favicon?: string | {
484
- light: string;
485
- dark: string;
486
- } | undefined;
487
- api?: {
488
- openapi?: string | string[] | {
489
- source: string;
490
- directory?: string | undefined;
491
- } | undefined;
492
- playground?: {
493
- display?: "simple" | "none" | "interactive" | undefined;
494
- proxy?: boolean | undefined;
495
- } | undefined;
496
- examples?: {
497
- languages?: string[] | undefined;
498
- } | undefined;
499
- mdx?: {
500
- auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
501
- server?: string | string[] | undefined;
502
- } | undefined;
503
- } | undefined;
504
- appearance?: {
505
- default?: "light" | "dark" | "system" | undefined;
506
- strict?: boolean | undefined;
507
- } | undefined;
508
- background?: {
509
- image?: string | {
510
- light: string;
511
- dark: string;
127
+ directory?: string | undefined;
128
+ }) & (string | string[] | {
129
+ source: string;
130
+ directory?: string | undefined;
131
+ } | undefined);
132
+ } | {
133
+ pages: any[];
134
+ }))[];
135
+ } | {
136
+ pages: any[];
137
+ })) & (({
138
+ global?: {
139
+ languages?: ({
140
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
141
+ hidden?: boolean | undefined;
142
+ } & {
143
+ href: string;
144
+ })[] | undefined;
145
+ versions?: ({
146
+ version: string;
147
+ hidden?: boolean | undefined;
148
+ } & {
149
+ href: string;
150
+ })[] | undefined;
151
+ tabs?: ({
152
+ tab: string;
153
+ icon?: string | {
154
+ name: string;
155
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
156
+ } | undefined;
157
+ hidden?: boolean | undefined;
158
+ } & {
159
+ href: string;
160
+ })[] | undefined;
161
+ dropdowns?: ({
162
+ dropdown: string;
163
+ icon?: string | {
164
+ name: string;
165
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
166
+ } | undefined;
167
+ hidden?: boolean | undefined;
168
+ } & {
169
+ href: string;
170
+ })[] | undefined;
171
+ anchors?: ({
172
+ anchor: string;
173
+ icon?: string | {
174
+ name: string;
175
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
512
176
  } | undefined;
513
- decoration?: "gradient" | "grid" | "windows" | undefined;
514
177
  color?: {
515
178
  light?: string | undefined;
516
179
  dark?: string | undefined;
517
180
  } | undefined;
181
+ hidden?: boolean | undefined;
182
+ } & {
183
+ href: string;
184
+ })[] | undefined;
185
+ } | undefined;
186
+ } & ({
187
+ languages: any[];
188
+ } | {
189
+ versions: any[];
190
+ } | {
191
+ tabs: any[];
192
+ } | {
193
+ dropdowns: any[];
194
+ } | {
195
+ anchors: any[];
196
+ } | {
197
+ groups: ({
198
+ group: string;
199
+ icon?: string | {
200
+ name: string;
201
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
202
+ } | undefined;
203
+ hidden?: boolean | undefined;
204
+ root?: string | {
205
+ href: string;
206
+ title: string;
207
+ sidebarTitle?: string | undefined;
208
+ description?: string | undefined;
209
+ api?: string | undefined;
210
+ openapi?: string | undefined;
211
+ contentType?: string | undefined;
212
+ authMethod?: string | undefined;
213
+ auth?: string | undefined;
214
+ version?: string | undefined;
215
+ mode?: string | undefined;
216
+ hideFooterPagination?: boolean | undefined;
217
+ authors?: unknown;
218
+ lastUpdatedDate?: string | undefined;
219
+ createdDate?: string | undefined;
220
+ "openapi-schema"?: string | undefined;
221
+ icon?: string | {
222
+ name: string;
223
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
224
+ } | undefined;
225
+ tag?: string | undefined;
226
+ url?: string | undefined;
227
+ hideApiMarker?: boolean | undefined;
228
+ noindex?: boolean | undefined;
229
+ isPublic?: boolean | undefined;
518
230
  } | undefined;
519
- topbar?: {
520
- links?: {
521
- href: string;
522
- label: string;
523
- }[] | undefined;
524
- primary?: {
525
- type: "button";
526
- href: string;
527
- label: string;
528
- } | {
529
- type: "github";
530
- href: string;
531
- } | undefined;
532
- } | undefined;
533
- footer?: {
534
- socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
535
- links?: {
536
- items: {
537
- href: string;
538
- label: string;
539
- }[];
540
- header?: string | undefined;
541
- }[] | undefined;
542
- } | undefined;
543
- search?: {
544
- prompt?: string | undefined;
545
- } | undefined;
546
- seo?: {
547
- metatags?: Record<string, string> | undefined;
548
- indexing?: "all" | "navigable" | undefined;
549
- } | undefined;
550
- fonts?: {
551
- family: string;
552
- weight?: number | undefined;
553
- source?: string | undefined;
554
- format?: "woff" | "woff2" | undefined;
555
- } | {
556
- heading?: {
557
- family: string;
558
- weight?: number | undefined;
559
- source?: string | undefined;
560
- format?: "woff" | "woff2" | undefined;
561
- } | undefined;
562
- body?: {
563
- family: string;
564
- weight?: number | undefined;
565
- source?: string | undefined;
566
- format?: "woff" | "woff2" | undefined;
567
- } | undefined;
568
- } | undefined;
569
- icons?: {
570
- library: "fontawesome";
571
- } | undefined;
572
- styling?: {
573
- rounded?: "regular" | "sharp" | undefined;
574
- eyebrows?: "section" | "breadcrumbs" | undefined;
575
- codeblocks?: "dark" | "system" | undefined;
576
- } | undefined;
577
- redirects?: {
231
+ } & ({
232
+ openapi: (string | string[] | {
578
233
  source: string;
579
- destination: string;
580
- permanent?: boolean | undefined;
581
- }[] | undefined;
582
- integrations?: {
583
- amplitude?: {
584
- apiKey: string;
585
- } | undefined;
586
- clearbit?: {
587
- publicApiKey: string;
588
- } | undefined;
589
- fathom?: {
590
- siteId: string;
591
- } | undefined;
592
- frontchat?: {
593
- snippetId: string;
594
- } | undefined;
595
- ga4?: {
596
- measurementId: string;
597
- } | undefined;
598
- gtm?: {
599
- tagId: string;
600
- } | undefined;
601
- heap?: {
602
- appId: string;
603
- } | undefined;
604
- hotjar?: {
605
- hjid: string;
606
- hjsv: string;
607
- } | undefined;
608
- intercom?: {
609
- appId: string;
610
- } | undefined;
611
- koala?: {
612
- publicApiKey: string;
613
- } | undefined;
614
- logrocket?: {
615
- appId: string;
616
- } | undefined;
617
- mixpanel?: {
618
- projectToken: string;
619
- } | undefined;
620
- osano?: {
621
- scriptSource: string;
622
- } | undefined;
623
- pirsch?: {
624
- id: string;
625
- } | undefined;
626
- posthog?: {
627
- apiKey: string;
628
- apiHost?: string | undefined;
629
- } | undefined;
630
- plausible?: {
631
- domain: string;
632
- server?: string | undefined;
633
- } | undefined;
634
- segment?: {
635
- key: string;
636
- } | undefined;
637
- } | undefined;
234
+ directory?: string | undefined;
235
+ }) & (string | string[] | {
236
+ source: string;
237
+ directory?: string | undefined;
238
+ } | undefined);
638
239
  } | {
639
- name: string;
640
- $schema: string;
641
- theme: "maple";
642
- colors: {
643
- primary: string;
644
- light?: string | undefined;
645
- dark?: string | undefined;
646
- };
647
- navigation: ({
648
- global?: {
649
- languages?: ({
650
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
651
- hidden?: boolean | undefined;
652
- } & {
653
- href: string;
654
- })[] | undefined;
655
- versions?: ({
656
- version: string;
657
- hidden?: boolean | undefined;
658
- } & {
659
- href: string;
660
- })[] | undefined;
661
- tabs?: ({
662
- tab: string;
663
- icon?: string | {
664
- name: string;
665
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
666
- } | undefined;
667
- hidden?: boolean | undefined;
668
- } & {
669
- href: string;
670
- })[] | undefined;
671
- dropdowns?: ({
672
- dropdown: string;
673
- icon?: string | {
674
- name: string;
675
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
676
- } | undefined;
677
- hidden?: boolean | undefined;
678
- } & {
679
- href: string;
680
- })[] | undefined;
681
- anchors?: ({
682
- anchor: string;
683
- icon?: string | {
684
- name: string;
685
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
686
- } | undefined;
687
- color?: {
688
- light?: string | undefined;
689
- dark?: string | undefined;
690
- } | undefined;
691
- hidden?: boolean | undefined;
692
- } & {
693
- href: string;
694
- })[] | undefined;
695
- } | undefined;
696
- } & ({
697
- languages: any[];
698
- } | {
699
- versions: any[];
700
- } | {
701
- tabs: any[];
702
- } | {
703
- dropdowns: any[];
704
- } | {
705
- anchors: any[];
706
- } | {
707
- groups: ({
708
- group: string;
709
- icon?: string | {
710
- name: string;
711
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
712
- } | undefined;
713
- hidden?: boolean | undefined;
714
- root?: string | {
715
- href: string;
716
- title: string;
717
- sidebarTitle?: string | undefined;
718
- description?: string | undefined;
719
- api?: string | undefined;
720
- openapi?: string | undefined;
721
- contentType?: string | undefined;
722
- authMethod?: string | undefined;
723
- auth?: string | undefined;
724
- version?: string | undefined;
725
- mode?: string | undefined;
726
- hideFooterPagination?: boolean | undefined;
727
- authors?: unknown;
728
- lastUpdatedDate?: string | undefined;
729
- createdDate?: string | undefined;
730
- "openapi-schema"?: string | undefined;
731
- icon?: string | {
732
- name: string;
733
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
734
- } | undefined;
735
- tag?: string | undefined;
736
- url?: string | undefined;
737
- hideApiMarker?: boolean | undefined;
738
- noindex?: boolean | undefined;
739
- isPublic?: boolean | undefined;
740
- } | undefined;
741
- } & ({
742
- openapi: (string | string[] | {
743
- source: string;
744
- directory?: string | undefined;
745
- }) & (string | string[] | {
746
- source: string;
747
- directory?: string | undefined;
748
- } | undefined);
749
- } | {
750
- pages: any[];
751
- }))[];
752
- } | {
753
- pages: any[];
754
- })) & (({
755
- global?: {
756
- languages?: ({
757
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
758
- hidden?: boolean | undefined;
759
- } & {
760
- href: string;
761
- })[] | undefined;
762
- versions?: ({
763
- version: string;
764
- hidden?: boolean | undefined;
765
- } & {
766
- href: string;
767
- })[] | undefined;
768
- tabs?: ({
769
- tab: string;
770
- icon?: string | {
771
- name: string;
772
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
773
- } | undefined;
774
- hidden?: boolean | undefined;
775
- } & {
776
- href: string;
777
- })[] | undefined;
778
- dropdowns?: ({
779
- dropdown: string;
780
- icon?: string | {
781
- name: string;
782
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
783
- } | undefined;
784
- hidden?: boolean | undefined;
785
- } & {
786
- href: string;
787
- })[] | undefined;
788
- anchors?: ({
789
- anchor: string;
790
- icon?: string | {
791
- name: string;
792
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
793
- } | undefined;
794
- color?: {
795
- light?: string | undefined;
796
- dark?: string | undefined;
797
- } | undefined;
798
- hidden?: boolean | undefined;
799
- } & {
800
- href: string;
801
- })[] | undefined;
802
- } | undefined;
803
- } & ({
804
- languages: any[];
805
- } | {
806
- versions: any[];
807
- } | {
808
- tabs: any[];
809
- } | {
810
- dropdowns: any[];
811
- } | {
812
- anchors: any[];
813
- } | {
814
- groups: ({
815
- group: string;
816
- icon?: string | {
817
- name: string;
818
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
819
- } | undefined;
820
- hidden?: boolean | undefined;
821
- root?: string | {
822
- href: string;
823
- title: string;
824
- sidebarTitle?: string | undefined;
825
- description?: string | undefined;
826
- api?: string | undefined;
827
- openapi?: string | undefined;
828
- contentType?: string | undefined;
829
- authMethod?: string | undefined;
830
- auth?: string | undefined;
831
- version?: string | undefined;
832
- mode?: string | undefined;
833
- hideFooterPagination?: boolean | undefined;
834
- authors?: unknown;
835
- lastUpdatedDate?: string | undefined;
836
- createdDate?: string | undefined;
837
- "openapi-schema"?: string | undefined;
838
- icon?: string | {
839
- name: string;
840
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
841
- } | undefined;
842
- tag?: string | undefined;
843
- url?: string | undefined;
844
- hideApiMarker?: boolean | undefined;
845
- noindex?: boolean | undefined;
846
- isPublic?: boolean | undefined;
847
- } | undefined;
848
- } & ({
849
- openapi: (string | string[] | {
850
- source: string;
851
- directory?: string | undefined;
852
- }) & (string | string[] | {
853
- source: string;
854
- directory?: string | undefined;
855
- } | undefined);
856
- } | {
857
- pages: any[];
858
- }))[];
859
- } | {
860
- pages: any[];
861
- })) | undefined);
862
- description?: string | undefined;
863
- logo?: string | {
864
- light: string;
865
- dark: string;
866
- href?: string | undefined;
867
- } | undefined;
868
- favicon?: string | {
869
- light: string;
870
- dark: string;
871
- } | undefined;
872
- api?: {
873
- openapi?: string | string[] | {
874
- source: string;
875
- directory?: string | undefined;
876
- } | undefined;
877
- playground?: {
878
- display?: "simple" | "none" | "interactive" | undefined;
879
- proxy?: boolean | undefined;
880
- } | undefined;
881
- examples?: {
882
- languages?: string[] | undefined;
883
- } | undefined;
884
- mdx?: {
885
- auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
886
- server?: string | string[] | undefined;
887
- } | undefined;
888
- } | undefined;
889
- appearance?: {
890
- default?: "light" | "dark" | "system" | undefined;
891
- strict?: boolean | undefined;
892
- } | undefined;
893
- background?: {
894
- image?: string | {
895
- light: string;
896
- dark: string;
240
+ pages: any[];
241
+ }))[];
242
+ } | {
243
+ pages: any[];
244
+ })) | undefined);
245
+ description?: string | undefined;
246
+ logo?: string | {
247
+ light: string;
248
+ dark: string;
249
+ href?: string | undefined;
250
+ } | undefined;
251
+ favicon?: string | {
252
+ light: string;
253
+ dark: string;
254
+ } | undefined;
255
+ api?: {
256
+ openapi?: string | string[] | {
257
+ source: string;
258
+ directory?: string | undefined;
259
+ } | undefined;
260
+ playground?: {
261
+ display?: "simple" | "none" | "interactive" | undefined;
262
+ proxy?: boolean | undefined;
263
+ } | undefined;
264
+ examples?: {
265
+ languages?: string[] | undefined;
266
+ } | undefined;
267
+ mdx?: {
268
+ auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
269
+ server?: string | string[] | undefined;
270
+ } | undefined;
271
+ } | undefined;
272
+ appearance?: {
273
+ default?: "light" | "dark" | "system" | undefined;
274
+ strict?: boolean | undefined;
275
+ } | undefined;
276
+ background?: {
277
+ image?: string | {
278
+ light: string;
279
+ dark: string;
280
+ } | undefined;
281
+ decoration?: "gradient" | "grid" | "windows" | undefined;
282
+ color?: {
283
+ light?: string | undefined;
284
+ dark?: string | undefined;
285
+ } | undefined;
286
+ } | undefined;
287
+ topbar?: {
288
+ links?: {
289
+ href: string;
290
+ label: string;
291
+ }[] | undefined;
292
+ primary?: {
293
+ type: "button";
294
+ href: string;
295
+ label: string;
296
+ } | {
297
+ type: "github";
298
+ href: string;
299
+ } | undefined;
300
+ } | undefined;
301
+ footer?: {
302
+ socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
303
+ links?: {
304
+ items: {
305
+ href: string;
306
+ label: string;
307
+ }[];
308
+ header?: string | undefined;
309
+ }[] | undefined;
310
+ } | undefined;
311
+ search?: {
312
+ prompt?: string | undefined;
313
+ } | undefined;
314
+ seo?: {
315
+ metatags?: Record<string, string> | undefined;
316
+ indexing?: "all" | "navigable" | undefined;
317
+ } | undefined;
318
+ fonts?: {
319
+ family: string;
320
+ weight?: number | undefined;
321
+ source?: string | undefined;
322
+ format?: "woff" | "woff2" | undefined;
323
+ } | {
324
+ heading?: {
325
+ family: string;
326
+ weight?: number | undefined;
327
+ source?: string | undefined;
328
+ format?: "woff" | "woff2" | undefined;
329
+ } | undefined;
330
+ body?: {
331
+ family: string;
332
+ weight?: number | undefined;
333
+ source?: string | undefined;
334
+ format?: "woff" | "woff2" | undefined;
335
+ } | undefined;
336
+ } | undefined;
337
+ icons?: {
338
+ library: "fontawesome";
339
+ } | undefined;
340
+ styling?: {
341
+ rounded?: "regular" | "sharp" | undefined;
342
+ eyebrows?: "section" | "breadcrumbs" | undefined;
343
+ codeblocks?: "dark" | "system" | undefined;
344
+ } | undefined;
345
+ redirects?: {
346
+ source: string;
347
+ destination: string;
348
+ permanent?: boolean | undefined;
349
+ }[] | undefined;
350
+ integrations?: {
351
+ amplitude?: {
352
+ apiKey: string;
353
+ } | undefined;
354
+ clearbit?: {
355
+ publicApiKey: string;
356
+ } | undefined;
357
+ fathom?: {
358
+ siteId: string;
359
+ } | undefined;
360
+ frontchat?: {
361
+ snippetId: string;
362
+ } | undefined;
363
+ ga4?: {
364
+ measurementId: string;
365
+ } | undefined;
366
+ gtm?: {
367
+ tagId: string;
368
+ } | undefined;
369
+ heap?: {
370
+ appId: string;
371
+ } | undefined;
372
+ hotjar?: {
373
+ hjid: string;
374
+ hjsv: string;
375
+ } | undefined;
376
+ intercom?: {
377
+ appId: string;
378
+ } | undefined;
379
+ koala?: {
380
+ publicApiKey: string;
381
+ } | undefined;
382
+ logrocket?: {
383
+ appId: string;
384
+ } | undefined;
385
+ mixpanel?: {
386
+ projectToken: string;
387
+ } | undefined;
388
+ osano?: {
389
+ scriptSource: string;
390
+ } | undefined;
391
+ pirsch?: {
392
+ id: string;
393
+ } | undefined;
394
+ posthog?: {
395
+ apiKey: string;
396
+ apiHost?: string | undefined;
397
+ } | undefined;
398
+ plausible?: {
399
+ domain: string;
400
+ server?: string | undefined;
401
+ } | undefined;
402
+ segment?: {
403
+ key: string;
404
+ } | undefined;
405
+ } | undefined;
406
+ } | {
407
+ name: string;
408
+ $schema: string;
409
+ theme: "maple";
410
+ colors: {
411
+ primary: string;
412
+ light?: string | undefined;
413
+ dark?: string | undefined;
414
+ };
415
+ navigation: ({
416
+ global?: {
417
+ languages?: ({
418
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
419
+ hidden?: boolean | undefined;
420
+ } & {
421
+ href: string;
422
+ })[] | undefined;
423
+ versions?: ({
424
+ version: string;
425
+ hidden?: boolean | undefined;
426
+ } & {
427
+ href: string;
428
+ })[] | undefined;
429
+ tabs?: ({
430
+ tab: string;
431
+ icon?: string | {
432
+ name: string;
433
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
434
+ } | undefined;
435
+ hidden?: boolean | undefined;
436
+ } & {
437
+ href: string;
438
+ })[] | undefined;
439
+ dropdowns?: ({
440
+ dropdown: string;
441
+ icon?: string | {
442
+ name: string;
443
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
444
+ } | undefined;
445
+ hidden?: boolean | undefined;
446
+ } & {
447
+ href: string;
448
+ })[] | undefined;
449
+ anchors?: ({
450
+ anchor: string;
451
+ icon?: string | {
452
+ name: string;
453
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
897
454
  } | undefined;
898
- decoration?: "gradient" | "grid" | "windows" | undefined;
899
455
  color?: {
900
456
  light?: string | undefined;
901
457
  dark?: string | undefined;
902
458
  } | undefined;
459
+ hidden?: boolean | undefined;
460
+ } & {
461
+ href: string;
462
+ })[] | undefined;
463
+ } | undefined;
464
+ } & ({
465
+ languages: any[];
466
+ } | {
467
+ versions: any[];
468
+ } | {
469
+ tabs: any[];
470
+ } | {
471
+ dropdowns: any[];
472
+ } | {
473
+ anchors: any[];
474
+ } | {
475
+ groups: ({
476
+ group: string;
477
+ icon?: string | {
478
+ name: string;
479
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
480
+ } | undefined;
481
+ hidden?: boolean | undefined;
482
+ root?: string | {
483
+ href: string;
484
+ title: string;
485
+ sidebarTitle?: string | undefined;
486
+ description?: string | undefined;
487
+ api?: string | undefined;
488
+ openapi?: string | undefined;
489
+ contentType?: string | undefined;
490
+ authMethod?: string | undefined;
491
+ auth?: string | undefined;
492
+ version?: string | undefined;
493
+ mode?: string | undefined;
494
+ hideFooterPagination?: boolean | undefined;
495
+ authors?: unknown;
496
+ lastUpdatedDate?: string | undefined;
497
+ createdDate?: string | undefined;
498
+ "openapi-schema"?: string | undefined;
499
+ icon?: string | {
500
+ name: string;
501
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
502
+ } | undefined;
503
+ tag?: string | undefined;
504
+ url?: string | undefined;
505
+ hideApiMarker?: boolean | undefined;
506
+ noindex?: boolean | undefined;
507
+ isPublic?: boolean | undefined;
903
508
  } | undefined;
904
- topbar?: {
905
- links?: {
906
- href: string;
907
- label: string;
908
- }[] | undefined;
909
- primary?: {
910
- type: "button";
911
- href: string;
912
- label: string;
913
- } | {
914
- type: "github";
915
- href: string;
916
- } | undefined;
917
- } | undefined;
918
- footer?: {
919
- socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
920
- links?: {
921
- items: {
922
- href: string;
923
- label: string;
924
- }[];
925
- header?: string | undefined;
926
- }[] | undefined;
927
- } | undefined;
928
- search?: {
929
- prompt?: string | undefined;
930
- } | undefined;
931
- seo?: {
932
- metatags?: Record<string, string> | undefined;
933
- indexing?: "all" | "navigable" | undefined;
934
- } | undefined;
935
- fonts?: {
936
- family: string;
937
- weight?: number | undefined;
938
- source?: string | undefined;
939
- format?: "woff" | "woff2" | undefined;
940
- } | {
941
- heading?: {
942
- family: string;
943
- weight?: number | undefined;
944
- source?: string | undefined;
945
- format?: "woff" | "woff2" | undefined;
946
- } | undefined;
947
- body?: {
948
- family: string;
949
- weight?: number | undefined;
950
- source?: string | undefined;
951
- format?: "woff" | "woff2" | undefined;
952
- } | undefined;
953
- } | undefined;
954
- icons?: {
955
- library: "fontawesome";
956
- } | undefined;
957
- styling?: {
958
- rounded?: "regular" | "sharp" | undefined;
959
- eyebrows?: "section" | "breadcrumbs" | undefined;
960
- codeblocks?: "dark" | "system" | undefined;
961
- } | undefined;
962
- redirects?: {
509
+ } & ({
510
+ openapi: (string | string[] | {
963
511
  source: string;
964
- destination: string;
965
- permanent?: boolean | undefined;
966
- }[] | undefined;
967
- integrations?: {
968
- amplitude?: {
969
- apiKey: string;
970
- } | undefined;
971
- clearbit?: {
972
- publicApiKey: string;
973
- } | undefined;
974
- fathom?: {
975
- siteId: string;
976
- } | undefined;
977
- frontchat?: {
978
- snippetId: string;
979
- } | undefined;
980
- ga4?: {
981
- measurementId: string;
982
- } | undefined;
983
- gtm?: {
984
- tagId: string;
985
- } | undefined;
986
- heap?: {
987
- appId: string;
988
- } | undefined;
989
- hotjar?: {
990
- hjid: string;
991
- hjsv: string;
992
- } | undefined;
993
- intercom?: {
994
- appId: string;
995
- } | undefined;
996
- koala?: {
997
- publicApiKey: string;
998
- } | undefined;
999
- logrocket?: {
1000
- appId: string;
1001
- } | undefined;
1002
- mixpanel?: {
1003
- projectToken: string;
1004
- } | undefined;
1005
- osano?: {
1006
- scriptSource: string;
1007
- } | undefined;
1008
- pirsch?: {
1009
- id: string;
1010
- } | undefined;
1011
- posthog?: {
1012
- apiKey: string;
1013
- apiHost?: string | undefined;
1014
- } | undefined;
1015
- plausible?: {
1016
- domain: string;
1017
- server?: string | undefined;
1018
- } | undefined;
1019
- segment?: {
1020
- key: string;
1021
- } | undefined;
1022
- } | undefined;
512
+ directory?: string | undefined;
513
+ }) & (string | string[] | {
514
+ source: string;
515
+ directory?: string | undefined;
516
+ } | undefined);
1023
517
  } | {
1024
- name: string;
1025
- $schema: string;
1026
- theme: "mint";
1027
- colors: {
1028
- primary: string;
1029
- light?: string | undefined;
1030
- dark?: string | undefined;
1031
- };
1032
- navigation: ({
1033
- global?: {
1034
- languages?: ({
1035
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1036
- hidden?: boolean | undefined;
1037
- } & {
1038
- href: string;
1039
- })[] | undefined;
1040
- versions?: ({
1041
- version: string;
1042
- hidden?: boolean | undefined;
1043
- } & {
1044
- href: string;
1045
- })[] | undefined;
1046
- tabs?: ({
1047
- tab: string;
1048
- icon?: string | {
1049
- name: string;
1050
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1051
- } | undefined;
1052
- hidden?: boolean | undefined;
1053
- } & {
1054
- href: string;
1055
- })[] | undefined;
1056
- dropdowns?: ({
1057
- dropdown: string;
1058
- icon?: string | {
1059
- name: string;
1060
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1061
- } | undefined;
1062
- hidden?: boolean | undefined;
1063
- } & {
1064
- href: string;
1065
- })[] | undefined;
1066
- anchors?: ({
1067
- anchor: string;
1068
- icon?: string | {
1069
- name: string;
1070
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1071
- } | undefined;
1072
- color?: {
1073
- light?: string | undefined;
1074
- dark?: string | undefined;
1075
- } | undefined;
1076
- hidden?: boolean | undefined;
1077
- } & {
1078
- href: string;
1079
- })[] | undefined;
1080
- } | undefined;
1081
- } & ({
1082
- languages: any[];
1083
- } | {
1084
- versions: any[];
1085
- } | {
1086
- tabs: any[];
1087
- } | {
1088
- dropdowns: any[];
1089
- } | {
1090
- anchors: any[];
1091
- } | {
1092
- groups: ({
1093
- group: string;
1094
- icon?: string | {
1095
- name: string;
1096
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1097
- } | undefined;
1098
- hidden?: boolean | undefined;
1099
- root?: string | {
1100
- href: string;
1101
- title: string;
1102
- sidebarTitle?: string | undefined;
1103
- description?: string | undefined;
1104
- api?: string | undefined;
1105
- openapi?: string | undefined;
1106
- contentType?: string | undefined;
1107
- authMethod?: string | undefined;
1108
- auth?: string | undefined;
1109
- version?: string | undefined;
1110
- mode?: string | undefined;
1111
- hideFooterPagination?: boolean | undefined;
1112
- authors?: unknown;
1113
- lastUpdatedDate?: string | undefined;
1114
- createdDate?: string | undefined;
1115
- "openapi-schema"?: string | undefined;
1116
- icon?: string | {
1117
- name: string;
1118
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1119
- } | undefined;
1120
- tag?: string | undefined;
1121
- url?: string | undefined;
1122
- hideApiMarker?: boolean | undefined;
1123
- noindex?: boolean | undefined;
1124
- isPublic?: boolean | undefined;
1125
- } | undefined;
1126
- } & ({
1127
- openapi: (string | string[] | {
1128
- source: string;
1129
- directory?: string | undefined;
1130
- }) & (string | string[] | {
1131
- source: string;
1132
- directory?: string | undefined;
1133
- } | undefined);
1134
- } | {
1135
- pages: any[];
1136
- }))[];
1137
- } | {
1138
- pages: any[];
1139
- })) & (({
1140
- global?: {
1141
- languages?: ({
1142
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1143
- hidden?: boolean | undefined;
1144
- } & {
1145
- href: string;
1146
- })[] | undefined;
1147
- versions?: ({
1148
- version: string;
1149
- hidden?: boolean | undefined;
1150
- } & {
1151
- href: string;
1152
- })[] | undefined;
1153
- tabs?: ({
1154
- tab: string;
1155
- icon?: string | {
1156
- name: string;
1157
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1158
- } | undefined;
1159
- hidden?: boolean | undefined;
1160
- } & {
1161
- href: string;
1162
- })[] | undefined;
1163
- dropdowns?: ({
1164
- dropdown: string;
1165
- icon?: string | {
1166
- name: string;
1167
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1168
- } | undefined;
1169
- hidden?: boolean | undefined;
1170
- } & {
1171
- href: string;
1172
- })[] | undefined;
1173
- anchors?: ({
1174
- anchor: string;
1175
- icon?: string | {
1176
- name: string;
1177
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1178
- } | undefined;
1179
- color?: {
1180
- light?: string | undefined;
1181
- dark?: string | undefined;
1182
- } | undefined;
1183
- hidden?: boolean | undefined;
1184
- } & {
1185
- href: string;
1186
- })[] | undefined;
1187
- } | undefined;
1188
- } & ({
1189
- languages: any[];
1190
- } | {
1191
- versions: any[];
1192
- } | {
1193
- tabs: any[];
1194
- } | {
1195
- dropdowns: any[];
1196
- } | {
1197
- anchors: any[];
1198
- } | {
1199
- groups: ({
1200
- group: string;
1201
- icon?: string | {
1202
- name: string;
1203
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1204
- } | undefined;
1205
- hidden?: boolean | undefined;
1206
- root?: string | {
1207
- href: string;
1208
- title: string;
1209
- sidebarTitle?: string | undefined;
1210
- description?: string | undefined;
1211
- api?: string | undefined;
1212
- openapi?: string | undefined;
1213
- contentType?: string | undefined;
1214
- authMethod?: string | undefined;
1215
- auth?: string | undefined;
1216
- version?: string | undefined;
1217
- mode?: string | undefined;
1218
- hideFooterPagination?: boolean | undefined;
1219
- authors?: unknown;
1220
- lastUpdatedDate?: string | undefined;
1221
- createdDate?: string | undefined;
1222
- "openapi-schema"?: string | undefined;
1223
- icon?: string | {
1224
- name: string;
1225
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1226
- } | undefined;
1227
- tag?: string | undefined;
1228
- url?: string | undefined;
1229
- hideApiMarker?: boolean | undefined;
1230
- noindex?: boolean | undefined;
1231
- isPublic?: boolean | undefined;
1232
- } | undefined;
1233
- } & ({
1234
- openapi: (string | string[] | {
1235
- source: string;
1236
- directory?: string | undefined;
1237
- }) & (string | string[] | {
1238
- source: string;
1239
- directory?: string | undefined;
1240
- } | undefined);
1241
- } | {
1242
- pages: any[];
1243
- }))[];
1244
- } | {
1245
- pages: any[];
1246
- })) | undefined);
1247
- description?: string | undefined;
1248
- logo?: string | {
1249
- light: string;
1250
- dark: string;
1251
- href?: string | undefined;
1252
- } | undefined;
1253
- favicon?: string | {
1254
- light: string;
1255
- dark: string;
1256
- } | undefined;
1257
- api?: {
1258
- openapi?: string | string[] | {
1259
- source: string;
1260
- directory?: string | undefined;
1261
- } | undefined;
1262
- playground?: {
1263
- display?: "simple" | "none" | "interactive" | undefined;
1264
- proxy?: boolean | undefined;
1265
- } | undefined;
1266
- examples?: {
1267
- languages?: string[] | undefined;
1268
- } | undefined;
1269
- mdx?: {
1270
- auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
1271
- server?: string | string[] | undefined;
1272
- } | undefined;
1273
- } | undefined;
1274
- appearance?: {
1275
- default?: "light" | "dark" | "system" | undefined;
1276
- strict?: boolean | undefined;
1277
- } | undefined;
1278
- background?: {
1279
- image?: string | {
1280
- light: string;
1281
- dark: string;
518
+ pages: any[];
519
+ }))[];
520
+ } | {
521
+ pages: any[];
522
+ })) & (({
523
+ global?: {
524
+ languages?: ({
525
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
526
+ hidden?: boolean | undefined;
527
+ } & {
528
+ href: string;
529
+ })[] | undefined;
530
+ versions?: ({
531
+ version: string;
532
+ hidden?: boolean | undefined;
533
+ } & {
534
+ href: string;
535
+ })[] | undefined;
536
+ tabs?: ({
537
+ tab: string;
538
+ icon?: string | {
539
+ name: string;
540
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
541
+ } | undefined;
542
+ hidden?: boolean | undefined;
543
+ } & {
544
+ href: string;
545
+ })[] | undefined;
546
+ dropdowns?: ({
547
+ dropdown: string;
548
+ icon?: string | {
549
+ name: string;
550
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
551
+ } | undefined;
552
+ hidden?: boolean | undefined;
553
+ } & {
554
+ href: string;
555
+ })[] | undefined;
556
+ anchors?: ({
557
+ anchor: string;
558
+ icon?: string | {
559
+ name: string;
560
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1282
561
  } | undefined;
1283
- decoration?: "gradient" | "grid" | "windows" | undefined;
1284
562
  color?: {
1285
563
  light?: string | undefined;
1286
564
  dark?: string | undefined;
1287
565
  } | undefined;
566
+ hidden?: boolean | undefined;
567
+ } & {
568
+ href: string;
569
+ })[] | undefined;
570
+ } | undefined;
571
+ } & ({
572
+ languages: any[];
573
+ } | {
574
+ versions: any[];
575
+ } | {
576
+ tabs: any[];
577
+ } | {
578
+ dropdowns: any[];
579
+ } | {
580
+ anchors: any[];
581
+ } | {
582
+ groups: ({
583
+ group: string;
584
+ icon?: string | {
585
+ name: string;
586
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
587
+ } | undefined;
588
+ hidden?: boolean | undefined;
589
+ root?: string | {
590
+ href: string;
591
+ title: string;
592
+ sidebarTitle?: string | undefined;
593
+ description?: string | undefined;
594
+ api?: string | undefined;
595
+ openapi?: string | undefined;
596
+ contentType?: string | undefined;
597
+ authMethod?: string | undefined;
598
+ auth?: string | undefined;
599
+ version?: string | undefined;
600
+ mode?: string | undefined;
601
+ hideFooterPagination?: boolean | undefined;
602
+ authors?: unknown;
603
+ lastUpdatedDate?: string | undefined;
604
+ createdDate?: string | undefined;
605
+ "openapi-schema"?: string | undefined;
606
+ icon?: string | {
607
+ name: string;
608
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
609
+ } | undefined;
610
+ tag?: string | undefined;
611
+ url?: string | undefined;
612
+ hideApiMarker?: boolean | undefined;
613
+ noindex?: boolean | undefined;
614
+ isPublic?: boolean | undefined;
1288
615
  } | undefined;
1289
- topbar?: {
1290
- links?: {
1291
- href: string;
1292
- label: string;
1293
- }[] | undefined;
1294
- primary?: {
1295
- type: "button";
1296
- href: string;
1297
- label: string;
1298
- } | {
1299
- type: "github";
1300
- href: string;
1301
- } | undefined;
1302
- } | undefined;
1303
- footer?: {
1304
- socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
1305
- links?: {
1306
- items: {
1307
- href: string;
1308
- label: string;
1309
- }[];
1310
- header?: string | undefined;
1311
- }[] | undefined;
1312
- } | undefined;
1313
- search?: {
1314
- prompt?: string | undefined;
1315
- } | undefined;
1316
- seo?: {
1317
- metatags?: Record<string, string> | undefined;
1318
- indexing?: "all" | "navigable" | undefined;
1319
- } | undefined;
1320
- fonts?: {
1321
- family: string;
1322
- weight?: number | undefined;
1323
- source?: string | undefined;
1324
- format?: "woff" | "woff2" | undefined;
1325
- } | {
1326
- heading?: {
1327
- family: string;
1328
- weight?: number | undefined;
1329
- source?: string | undefined;
1330
- format?: "woff" | "woff2" | undefined;
1331
- } | undefined;
1332
- body?: {
1333
- family: string;
1334
- weight?: number | undefined;
1335
- source?: string | undefined;
1336
- format?: "woff" | "woff2" | undefined;
1337
- } | undefined;
1338
- } | undefined;
1339
- icons?: {
1340
- library: "fontawesome";
1341
- } | undefined;
1342
- styling?: {
1343
- rounded?: "regular" | "sharp" | undefined;
1344
- eyebrows?: "section" | "breadcrumbs" | undefined;
1345
- codeblocks?: "dark" | "system" | undefined;
1346
- } | undefined;
1347
- redirects?: {
616
+ } & ({
617
+ openapi: (string | string[] | {
1348
618
  source: string;
1349
- destination: string;
1350
- permanent?: boolean | undefined;
1351
- }[] | undefined;
1352
- integrations?: {
1353
- amplitude?: {
1354
- apiKey: string;
1355
- } | undefined;
1356
- clearbit?: {
1357
- publicApiKey: string;
1358
- } | undefined;
1359
- fathom?: {
1360
- siteId: string;
1361
- } | undefined;
1362
- frontchat?: {
1363
- snippetId: string;
1364
- } | undefined;
1365
- ga4?: {
1366
- measurementId: string;
1367
- } | undefined;
1368
- gtm?: {
1369
- tagId: string;
1370
- } | undefined;
1371
- heap?: {
1372
- appId: string;
1373
- } | undefined;
1374
- hotjar?: {
1375
- hjid: string;
1376
- hjsv: string;
1377
- } | undefined;
1378
- intercom?: {
1379
- appId: string;
1380
- } | undefined;
1381
- koala?: {
1382
- publicApiKey: string;
1383
- } | undefined;
1384
- logrocket?: {
1385
- appId: string;
1386
- } | undefined;
1387
- mixpanel?: {
1388
- projectToken: string;
1389
- } | undefined;
1390
- osano?: {
1391
- scriptSource: string;
1392
- } | undefined;
1393
- pirsch?: {
1394
- id: string;
1395
- } | undefined;
1396
- posthog?: {
1397
- apiKey: string;
1398
- apiHost?: string | undefined;
1399
- } | undefined;
1400
- plausible?: {
1401
- domain: string;
1402
- server?: string | undefined;
1403
- } | undefined;
1404
- segment?: {
1405
- key: string;
1406
- } | undefined;
1407
- } | undefined;
619
+ directory?: string | undefined;
620
+ }) & (string | string[] | {
621
+ source: string;
622
+ directory?: string | undefined;
623
+ } | undefined);
1408
624
  } | {
1409
- name: string;
1410
- $schema: string;
1411
- theme: "palm";
1412
- colors: {
1413
- primary: string;
1414
- light?: string | undefined;
1415
- dark?: string | undefined;
1416
- };
1417
- navigation: ({
1418
- global?: {
1419
- languages?: ({
1420
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1421
- hidden?: boolean | undefined;
1422
- } & {
1423
- href: string;
1424
- })[] | undefined;
1425
- versions?: ({
1426
- version: string;
1427
- hidden?: boolean | undefined;
1428
- } & {
1429
- href: string;
1430
- })[] | undefined;
1431
- tabs?: ({
1432
- tab: string;
1433
- icon?: string | {
1434
- name: string;
1435
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1436
- } | undefined;
1437
- hidden?: boolean | undefined;
1438
- } & {
1439
- href: string;
1440
- })[] | undefined;
1441
- dropdowns?: ({
1442
- dropdown: string;
1443
- icon?: string | {
1444
- name: string;
1445
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1446
- } | undefined;
1447
- hidden?: boolean | undefined;
1448
- } & {
1449
- href: string;
1450
- })[] | undefined;
1451
- anchors?: ({
1452
- anchor: string;
1453
- icon?: string | {
1454
- name: string;
1455
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1456
- } | undefined;
1457
- color?: {
1458
- light?: string | undefined;
1459
- dark?: string | undefined;
1460
- } | undefined;
1461
- hidden?: boolean | undefined;
1462
- } & {
1463
- href: string;
1464
- })[] | undefined;
1465
- } | undefined;
1466
- } & ({
1467
- languages: any[];
1468
- } | {
1469
- versions: any[];
1470
- } | {
1471
- tabs: any[];
1472
- } | {
1473
- dropdowns: any[];
1474
- } | {
1475
- anchors: any[];
1476
- } | {
1477
- groups: ({
1478
- group: string;
1479
- icon?: string | {
1480
- name: string;
1481
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1482
- } | undefined;
1483
- hidden?: boolean | undefined;
1484
- root?: string | {
1485
- href: string;
1486
- title: string;
1487
- sidebarTitle?: string | undefined;
1488
- description?: string | undefined;
1489
- api?: string | undefined;
1490
- openapi?: string | undefined;
1491
- contentType?: string | undefined;
1492
- authMethod?: string | undefined;
1493
- auth?: string | undefined;
1494
- version?: string | undefined;
1495
- mode?: string | undefined;
1496
- hideFooterPagination?: boolean | undefined;
1497
- authors?: unknown;
1498
- lastUpdatedDate?: string | undefined;
1499
- createdDate?: string | undefined;
1500
- "openapi-schema"?: string | undefined;
1501
- icon?: string | {
1502
- name: string;
1503
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1504
- } | undefined;
1505
- tag?: string | undefined;
1506
- url?: string | undefined;
1507
- hideApiMarker?: boolean | undefined;
1508
- noindex?: boolean | undefined;
1509
- isPublic?: boolean | undefined;
1510
- } | undefined;
1511
- } & ({
1512
- openapi: (string | string[] | {
1513
- source: string;
1514
- directory?: string | undefined;
1515
- }) & (string | string[] | {
1516
- source: string;
1517
- directory?: string | undefined;
1518
- } | undefined);
1519
- } | {
1520
- pages: any[];
1521
- }))[];
1522
- } | {
1523
- pages: any[];
1524
- })) & (({
1525
- global?: {
1526
- languages?: ({
1527
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1528
- hidden?: boolean | undefined;
1529
- } & {
1530
- href: string;
1531
- })[] | undefined;
1532
- versions?: ({
1533
- version: string;
1534
- hidden?: boolean | undefined;
1535
- } & {
1536
- href: string;
1537
- })[] | undefined;
1538
- tabs?: ({
1539
- tab: string;
1540
- icon?: string | {
1541
- name: string;
1542
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1543
- } | undefined;
1544
- hidden?: boolean | undefined;
1545
- } & {
1546
- href: string;
1547
- })[] | undefined;
1548
- dropdowns?: ({
1549
- dropdown: string;
1550
- icon?: string | {
1551
- name: string;
1552
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1553
- } | undefined;
1554
- hidden?: boolean | undefined;
1555
- } & {
1556
- href: string;
1557
- })[] | undefined;
1558
- anchors?: ({
1559
- anchor: string;
1560
- icon?: string | {
1561
- name: string;
1562
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1563
- } | undefined;
1564
- color?: {
1565
- light?: string | undefined;
1566
- dark?: string | undefined;
1567
- } | undefined;
1568
- hidden?: boolean | undefined;
1569
- } & {
1570
- href: string;
1571
- })[] | undefined;
1572
- } | undefined;
1573
- } & ({
1574
- languages: any[];
1575
- } | {
1576
- versions: any[];
1577
- } | {
1578
- tabs: any[];
1579
- } | {
1580
- dropdowns: any[];
1581
- } | {
1582
- anchors: any[];
1583
- } | {
1584
- groups: ({
1585
- group: string;
1586
- icon?: string | {
1587
- name: string;
1588
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1589
- } | undefined;
1590
- hidden?: boolean | undefined;
1591
- root?: string | {
1592
- href: string;
1593
- title: string;
1594
- sidebarTitle?: string | undefined;
1595
- description?: string | undefined;
1596
- api?: string | undefined;
1597
- openapi?: string | undefined;
1598
- contentType?: string | undefined;
1599
- authMethod?: string | undefined;
1600
- auth?: string | undefined;
1601
- version?: string | undefined;
1602
- mode?: string | undefined;
1603
- hideFooterPagination?: boolean | undefined;
1604
- authors?: unknown;
1605
- lastUpdatedDate?: string | undefined;
1606
- createdDate?: string | undefined;
1607
- "openapi-schema"?: string | undefined;
1608
- icon?: string | {
1609
- name: string;
1610
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1611
- } | undefined;
1612
- tag?: string | undefined;
1613
- url?: string | undefined;
1614
- hideApiMarker?: boolean | undefined;
1615
- noindex?: boolean | undefined;
1616
- isPublic?: boolean | undefined;
1617
- } | undefined;
1618
- } & ({
1619
- openapi: (string | string[] | {
1620
- source: string;
1621
- directory?: string | undefined;
1622
- }) & (string | string[] | {
1623
- source: string;
1624
- directory?: string | undefined;
1625
- } | undefined);
1626
- } | {
1627
- pages: any[];
1628
- }))[];
1629
- } | {
1630
- pages: any[];
1631
- })) | undefined);
1632
- description?: string | undefined;
1633
- logo?: string | {
1634
- light: string;
1635
- dark: string;
1636
- href?: string | undefined;
1637
- } | undefined;
1638
- favicon?: string | {
1639
- light: string;
1640
- dark: string;
1641
- } | undefined;
1642
- api?: {
1643
- openapi?: string | string[] | {
1644
- source: string;
1645
- directory?: string | undefined;
1646
- } | undefined;
1647
- playground?: {
1648
- display?: "simple" | "none" | "interactive" | undefined;
1649
- proxy?: boolean | undefined;
1650
- } | undefined;
1651
- examples?: {
1652
- languages?: string[] | undefined;
1653
- } | undefined;
1654
- mdx?: {
1655
- auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
1656
- server?: string | string[] | undefined;
1657
- } | undefined;
1658
- } | undefined;
1659
- appearance?: {
1660
- default?: "light" | "dark" | "system" | undefined;
1661
- strict?: boolean | undefined;
1662
- } | undefined;
1663
- background?: {
1664
- image?: string | {
1665
- light: string;
1666
- dark: string;
625
+ pages: any[];
626
+ }))[];
627
+ } | {
628
+ pages: any[];
629
+ })) | undefined);
630
+ description?: string | undefined;
631
+ logo?: string | {
632
+ light: string;
633
+ dark: string;
634
+ href?: string | undefined;
635
+ } | undefined;
636
+ favicon?: string | {
637
+ light: string;
638
+ dark: string;
639
+ } | undefined;
640
+ api?: {
641
+ openapi?: string | string[] | {
642
+ source: string;
643
+ directory?: string | undefined;
644
+ } | undefined;
645
+ playground?: {
646
+ display?: "simple" | "none" | "interactive" | undefined;
647
+ proxy?: boolean | undefined;
648
+ } | undefined;
649
+ examples?: {
650
+ languages?: string[] | undefined;
651
+ } | undefined;
652
+ mdx?: {
653
+ auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
654
+ server?: string | string[] | undefined;
655
+ } | undefined;
656
+ } | undefined;
657
+ appearance?: {
658
+ default?: "light" | "dark" | "system" | undefined;
659
+ strict?: boolean | undefined;
660
+ } | undefined;
661
+ background?: {
662
+ image?: string | {
663
+ light: string;
664
+ dark: string;
665
+ } | undefined;
666
+ decoration?: "gradient" | "grid" | "windows" | undefined;
667
+ color?: {
668
+ light?: string | undefined;
669
+ dark?: string | undefined;
670
+ } | undefined;
671
+ } | undefined;
672
+ topbar?: {
673
+ links?: {
674
+ href: string;
675
+ label: string;
676
+ }[] | undefined;
677
+ primary?: {
678
+ type: "button";
679
+ href: string;
680
+ label: string;
681
+ } | {
682
+ type: "github";
683
+ href: string;
684
+ } | undefined;
685
+ } | undefined;
686
+ footer?: {
687
+ socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
688
+ links?: {
689
+ items: {
690
+ href: string;
691
+ label: string;
692
+ }[];
693
+ header?: string | undefined;
694
+ }[] | undefined;
695
+ } | undefined;
696
+ search?: {
697
+ prompt?: string | undefined;
698
+ } | undefined;
699
+ seo?: {
700
+ metatags?: Record<string, string> | undefined;
701
+ indexing?: "all" | "navigable" | undefined;
702
+ } | undefined;
703
+ fonts?: {
704
+ family: string;
705
+ weight?: number | undefined;
706
+ source?: string | undefined;
707
+ format?: "woff" | "woff2" | undefined;
708
+ } | {
709
+ heading?: {
710
+ family: string;
711
+ weight?: number | undefined;
712
+ source?: string | undefined;
713
+ format?: "woff" | "woff2" | undefined;
714
+ } | undefined;
715
+ body?: {
716
+ family: string;
717
+ weight?: number | undefined;
718
+ source?: string | undefined;
719
+ format?: "woff" | "woff2" | undefined;
720
+ } | undefined;
721
+ } | undefined;
722
+ icons?: {
723
+ library: "fontawesome";
724
+ } | undefined;
725
+ styling?: {
726
+ rounded?: "regular" | "sharp" | undefined;
727
+ eyebrows?: "section" | "breadcrumbs" | undefined;
728
+ codeblocks?: "dark" | "system" | undefined;
729
+ } | undefined;
730
+ redirects?: {
731
+ source: string;
732
+ destination: string;
733
+ permanent?: boolean | undefined;
734
+ }[] | undefined;
735
+ integrations?: {
736
+ amplitude?: {
737
+ apiKey: string;
738
+ } | undefined;
739
+ clearbit?: {
740
+ publicApiKey: string;
741
+ } | undefined;
742
+ fathom?: {
743
+ siteId: string;
744
+ } | undefined;
745
+ frontchat?: {
746
+ snippetId: string;
747
+ } | undefined;
748
+ ga4?: {
749
+ measurementId: string;
750
+ } | undefined;
751
+ gtm?: {
752
+ tagId: string;
753
+ } | undefined;
754
+ heap?: {
755
+ appId: string;
756
+ } | undefined;
757
+ hotjar?: {
758
+ hjid: string;
759
+ hjsv: string;
760
+ } | undefined;
761
+ intercom?: {
762
+ appId: string;
763
+ } | undefined;
764
+ koala?: {
765
+ publicApiKey: string;
766
+ } | undefined;
767
+ logrocket?: {
768
+ appId: string;
769
+ } | undefined;
770
+ mixpanel?: {
771
+ projectToken: string;
772
+ } | undefined;
773
+ osano?: {
774
+ scriptSource: string;
775
+ } | undefined;
776
+ pirsch?: {
777
+ id: string;
778
+ } | undefined;
779
+ posthog?: {
780
+ apiKey: string;
781
+ apiHost?: string | undefined;
782
+ } | undefined;
783
+ plausible?: {
784
+ domain: string;
785
+ server?: string | undefined;
786
+ } | undefined;
787
+ segment?: {
788
+ key: string;
789
+ } | undefined;
790
+ } | undefined;
791
+ } | {
792
+ name: string;
793
+ $schema: string;
794
+ theme: "palm";
795
+ colors: {
796
+ primary: string;
797
+ light?: string | undefined;
798
+ dark?: string | undefined;
799
+ };
800
+ navigation: ({
801
+ global?: {
802
+ languages?: ({
803
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
804
+ hidden?: boolean | undefined;
805
+ } & {
806
+ href: string;
807
+ })[] | undefined;
808
+ versions?: ({
809
+ version: string;
810
+ hidden?: boolean | undefined;
811
+ } & {
812
+ href: string;
813
+ })[] | undefined;
814
+ tabs?: ({
815
+ tab: string;
816
+ icon?: string | {
817
+ name: string;
818
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
819
+ } | undefined;
820
+ hidden?: boolean | undefined;
821
+ } & {
822
+ href: string;
823
+ })[] | undefined;
824
+ dropdowns?: ({
825
+ dropdown: string;
826
+ icon?: string | {
827
+ name: string;
828
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
829
+ } | undefined;
830
+ hidden?: boolean | undefined;
831
+ } & {
832
+ href: string;
833
+ })[] | undefined;
834
+ anchors?: ({
835
+ anchor: string;
836
+ icon?: string | {
837
+ name: string;
838
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1667
839
  } | undefined;
1668
- decoration?: "gradient" | "grid" | "windows" | undefined;
1669
840
  color?: {
1670
841
  light?: string | undefined;
1671
842
  dark?: string | undefined;
1672
843
  } | undefined;
844
+ hidden?: boolean | undefined;
845
+ } & {
846
+ href: string;
847
+ })[] | undefined;
848
+ } | undefined;
849
+ } & ({
850
+ languages: any[];
851
+ } | {
852
+ versions: any[];
853
+ } | {
854
+ tabs: any[];
855
+ } | {
856
+ dropdowns: any[];
857
+ } | {
858
+ anchors: any[];
859
+ } | {
860
+ groups: ({
861
+ group: string;
862
+ icon?: string | {
863
+ name: string;
864
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
865
+ } | undefined;
866
+ hidden?: boolean | undefined;
867
+ root?: string | {
868
+ href: string;
869
+ title: string;
870
+ sidebarTitle?: string | undefined;
871
+ description?: string | undefined;
872
+ api?: string | undefined;
873
+ openapi?: string | undefined;
874
+ contentType?: string | undefined;
875
+ authMethod?: string | undefined;
876
+ auth?: string | undefined;
877
+ version?: string | undefined;
878
+ mode?: string | undefined;
879
+ hideFooterPagination?: boolean | undefined;
880
+ authors?: unknown;
881
+ lastUpdatedDate?: string | undefined;
882
+ createdDate?: string | undefined;
883
+ "openapi-schema"?: string | undefined;
884
+ icon?: string | {
885
+ name: string;
886
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
887
+ } | undefined;
888
+ tag?: string | undefined;
889
+ url?: string | undefined;
890
+ hideApiMarker?: boolean | undefined;
891
+ noindex?: boolean | undefined;
892
+ isPublic?: boolean | undefined;
1673
893
  } | undefined;
1674
- topbar?: {
1675
- links?: {
1676
- href: string;
1677
- label: string;
1678
- }[] | undefined;
1679
- primary?: {
1680
- type: "button";
1681
- href: string;
1682
- label: string;
1683
- } | {
1684
- type: "github";
1685
- href: string;
1686
- } | undefined;
1687
- } | undefined;
1688
- footer?: {
1689
- socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
1690
- links?: {
1691
- items: {
1692
- href: string;
1693
- label: string;
1694
- }[];
1695
- header?: string | undefined;
1696
- }[] | undefined;
1697
- } | undefined;
1698
- search?: {
1699
- prompt?: string | undefined;
1700
- } | undefined;
1701
- seo?: {
1702
- metatags?: Record<string, string> | undefined;
1703
- indexing?: "all" | "navigable" | undefined;
1704
- } | undefined;
1705
- fonts?: {
1706
- family: string;
1707
- weight?: number | undefined;
1708
- source?: string | undefined;
1709
- format?: "woff" | "woff2" | undefined;
1710
- } | {
1711
- heading?: {
1712
- family: string;
1713
- weight?: number | undefined;
1714
- source?: string | undefined;
1715
- format?: "woff" | "woff2" | undefined;
1716
- } | undefined;
1717
- body?: {
1718
- family: string;
1719
- weight?: number | undefined;
1720
- source?: string | undefined;
1721
- format?: "woff" | "woff2" | undefined;
1722
- } | undefined;
1723
- } | undefined;
1724
- icons?: {
1725
- library: "fontawesome";
1726
- } | undefined;
1727
- styling?: {
1728
- rounded?: "regular" | "sharp" | undefined;
1729
- eyebrows?: "section" | "breadcrumbs" | undefined;
1730
- codeblocks?: "dark" | "system" | undefined;
1731
- } | undefined;
1732
- redirects?: {
894
+ } & ({
895
+ openapi: (string | string[] | {
1733
896
  source: string;
1734
- destination: string;
1735
- permanent?: boolean | undefined;
1736
- }[] | undefined;
1737
- integrations?: {
1738
- amplitude?: {
1739
- apiKey: string;
1740
- } | undefined;
1741
- clearbit?: {
1742
- publicApiKey: string;
1743
- } | undefined;
1744
- fathom?: {
1745
- siteId: string;
1746
- } | undefined;
1747
- frontchat?: {
1748
- snippetId: string;
1749
- } | undefined;
1750
- ga4?: {
1751
- measurementId: string;
1752
- } | undefined;
1753
- gtm?: {
1754
- tagId: string;
1755
- } | undefined;
1756
- heap?: {
1757
- appId: string;
1758
- } | undefined;
1759
- hotjar?: {
1760
- hjid: string;
1761
- hjsv: string;
1762
- } | undefined;
1763
- intercom?: {
1764
- appId: string;
1765
- } | undefined;
1766
- koala?: {
1767
- publicApiKey: string;
1768
- } | undefined;
1769
- logrocket?: {
1770
- appId: string;
1771
- } | undefined;
1772
- mixpanel?: {
1773
- projectToken: string;
1774
- } | undefined;
1775
- osano?: {
1776
- scriptSource: string;
1777
- } | undefined;
1778
- pirsch?: {
1779
- id: string;
1780
- } | undefined;
1781
- posthog?: {
1782
- apiKey: string;
1783
- apiHost?: string | undefined;
1784
- } | undefined;
1785
- plausible?: {
1786
- domain: string;
1787
- server?: string | undefined;
1788
- } | undefined;
1789
- segment?: {
1790
- key: string;
1791
- } | undefined;
1792
- } | undefined;
897
+ directory?: string | undefined;
898
+ }) & (string | string[] | {
899
+ source: string;
900
+ directory?: string | undefined;
901
+ } | undefined);
1793
902
  } | {
1794
- name: string;
1795
- $schema: string;
1796
- theme: "willow";
1797
- colors: {
1798
- primary: string;
1799
- light?: string | undefined;
1800
- dark?: string | undefined;
1801
- };
1802
- navigation: ({
1803
- global?: {
1804
- languages?: ({
1805
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1806
- hidden?: boolean | undefined;
1807
- } & {
1808
- href: string;
1809
- })[] | undefined;
1810
- versions?: ({
1811
- version: string;
1812
- hidden?: boolean | undefined;
1813
- } & {
1814
- href: string;
1815
- })[] | undefined;
1816
- tabs?: ({
1817
- tab: string;
1818
- icon?: string | {
1819
- name: string;
1820
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1821
- } | undefined;
1822
- hidden?: boolean | undefined;
1823
- } & {
1824
- href: string;
1825
- })[] | undefined;
1826
- dropdowns?: ({
1827
- dropdown: string;
1828
- icon?: string | {
1829
- name: string;
1830
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1831
- } | undefined;
1832
- hidden?: boolean | undefined;
1833
- } & {
1834
- href: string;
1835
- })[] | undefined;
1836
- anchors?: ({
1837
- anchor: string;
1838
- icon?: string | {
1839
- name: string;
1840
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1841
- } | undefined;
1842
- color?: {
1843
- light?: string | undefined;
1844
- dark?: string | undefined;
1845
- } | undefined;
1846
- hidden?: boolean | undefined;
1847
- } & {
1848
- href: string;
1849
- })[] | undefined;
903
+ pages: any[];
904
+ }))[];
905
+ } | {
906
+ pages: any[];
907
+ })) & (({
908
+ global?: {
909
+ languages?: ({
910
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
911
+ hidden?: boolean | undefined;
912
+ } & {
913
+ href: string;
914
+ })[] | undefined;
915
+ versions?: ({
916
+ version: string;
917
+ hidden?: boolean | undefined;
918
+ } & {
919
+ href: string;
920
+ })[] | undefined;
921
+ tabs?: ({
922
+ tab: string;
923
+ icon?: string | {
924
+ name: string;
925
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
926
+ } | undefined;
927
+ hidden?: boolean | undefined;
928
+ } & {
929
+ href: string;
930
+ })[] | undefined;
931
+ dropdowns?: ({
932
+ dropdown: string;
933
+ icon?: string | {
934
+ name: string;
935
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
936
+ } | undefined;
937
+ hidden?: boolean | undefined;
938
+ } & {
939
+ href: string;
940
+ })[] | undefined;
941
+ anchors?: ({
942
+ anchor: string;
943
+ icon?: string | {
944
+ name: string;
945
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1850
946
  } | undefined;
1851
- } & ({
1852
- languages: any[];
1853
- } | {
1854
- versions: any[];
1855
- } | {
1856
- tabs: any[];
1857
- } | {
1858
- dropdowns: any[];
1859
- } | {
1860
- anchors: any[];
1861
- } | {
1862
- groups: ({
1863
- group: string;
1864
- icon?: string | {
1865
- name: string;
1866
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1867
- } | undefined;
1868
- hidden?: boolean | undefined;
1869
- root?: string | {
1870
- href: string;
1871
- title: string;
1872
- sidebarTitle?: string | undefined;
1873
- description?: string | undefined;
1874
- api?: string | undefined;
1875
- openapi?: string | undefined;
1876
- contentType?: string | undefined;
1877
- authMethod?: string | undefined;
1878
- auth?: string | undefined;
1879
- version?: string | undefined;
1880
- mode?: string | undefined;
1881
- hideFooterPagination?: boolean | undefined;
1882
- authors?: unknown;
1883
- lastUpdatedDate?: string | undefined;
1884
- createdDate?: string | undefined;
1885
- "openapi-schema"?: string | undefined;
1886
- icon?: string | {
1887
- name: string;
1888
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1889
- } | undefined;
1890
- tag?: string | undefined;
1891
- url?: string | undefined;
1892
- hideApiMarker?: boolean | undefined;
1893
- noindex?: boolean | undefined;
1894
- isPublic?: boolean | undefined;
1895
- } | undefined;
1896
- } & ({
1897
- openapi: (string | string[] | {
1898
- source: string;
1899
- directory?: string | undefined;
1900
- }) & (string | string[] | {
1901
- source: string;
1902
- directory?: string | undefined;
1903
- } | undefined);
1904
- } | {
1905
- pages: any[];
1906
- }))[];
1907
- } | {
1908
- pages: any[];
1909
- })) & (({
1910
- global?: {
1911
- languages?: ({
1912
- language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1913
- hidden?: boolean | undefined;
1914
- } & {
1915
- href: string;
1916
- })[] | undefined;
1917
- versions?: ({
1918
- version: string;
1919
- hidden?: boolean | undefined;
1920
- } & {
1921
- href: string;
1922
- })[] | undefined;
1923
- tabs?: ({
1924
- tab: string;
1925
- icon?: string | {
1926
- name: string;
1927
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1928
- } | undefined;
1929
- hidden?: boolean | undefined;
1930
- } & {
1931
- href: string;
1932
- })[] | undefined;
1933
- dropdowns?: ({
1934
- dropdown: string;
1935
- icon?: string | {
1936
- name: string;
1937
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1938
- } | undefined;
1939
- hidden?: boolean | undefined;
1940
- } & {
1941
- href: string;
1942
- })[] | undefined;
1943
- anchors?: ({
1944
- anchor: string;
1945
- icon?: string | {
1946
- name: string;
1947
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1948
- } | undefined;
1949
- color?: {
1950
- light?: string | undefined;
1951
- dark?: string | undefined;
1952
- } | undefined;
1953
- hidden?: boolean | undefined;
1954
- } & {
1955
- href: string;
1956
- })[] | undefined;
947
+ color?: {
948
+ light?: string | undefined;
949
+ dark?: string | undefined;
1957
950
  } | undefined;
1958
- } & ({
1959
- languages: any[];
1960
- } | {
1961
- versions: any[];
1962
- } | {
1963
- tabs: any[];
1964
- } | {
1965
- dropdowns: any[];
1966
- } | {
1967
- anchors: any[];
1968
- } | {
1969
- groups: ({
1970
- group: string;
1971
- icon?: string | {
1972
- name: string;
1973
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1974
- } | undefined;
1975
- hidden?: boolean | undefined;
1976
- root?: string | {
1977
- href: string;
1978
- title: string;
1979
- sidebarTitle?: string | undefined;
1980
- description?: string | undefined;
1981
- api?: string | undefined;
1982
- openapi?: string | undefined;
1983
- contentType?: string | undefined;
1984
- authMethod?: string | undefined;
1985
- auth?: string | undefined;
1986
- version?: string | undefined;
1987
- mode?: string | undefined;
1988
- hideFooterPagination?: boolean | undefined;
1989
- authors?: unknown;
1990
- lastUpdatedDate?: string | undefined;
1991
- createdDate?: string | undefined;
1992
- "openapi-schema"?: string | undefined;
1993
- icon?: string | {
1994
- name: string;
1995
- style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1996
- } | undefined;
1997
- tag?: string | undefined;
1998
- url?: string | undefined;
1999
- hideApiMarker?: boolean | undefined;
2000
- noindex?: boolean | undefined;
2001
- isPublic?: boolean | undefined;
2002
- } | undefined;
2003
- } & ({
2004
- openapi: (string | string[] | {
2005
- source: string;
2006
- directory?: string | undefined;
2007
- }) & (string | string[] | {
2008
- source: string;
2009
- directory?: string | undefined;
2010
- } | undefined);
2011
- } | {
2012
- pages: any[];
2013
- }))[];
2014
- } | {
2015
- pages: any[];
2016
- })) | undefined);
2017
- description?: string | undefined;
2018
- logo?: string | {
2019
- light: string;
2020
- dark: string;
2021
- href?: string | undefined;
2022
- } | undefined;
2023
- favicon?: string | {
2024
- light: string;
2025
- dark: string;
951
+ hidden?: boolean | undefined;
952
+ } & {
953
+ href: string;
954
+ })[] | undefined;
955
+ } | undefined;
956
+ } & ({
957
+ languages: any[];
958
+ } | {
959
+ versions: any[];
960
+ } | {
961
+ tabs: any[];
962
+ } | {
963
+ dropdowns: any[];
964
+ } | {
965
+ anchors: any[];
966
+ } | {
967
+ groups: ({
968
+ group: string;
969
+ icon?: string | {
970
+ name: string;
971
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
972
+ } | undefined;
973
+ hidden?: boolean | undefined;
974
+ root?: string | {
975
+ href: string;
976
+ title: string;
977
+ sidebarTitle?: string | undefined;
978
+ description?: string | undefined;
979
+ api?: string | undefined;
980
+ openapi?: string | undefined;
981
+ contentType?: string | undefined;
982
+ authMethod?: string | undefined;
983
+ auth?: string | undefined;
984
+ version?: string | undefined;
985
+ mode?: string | undefined;
986
+ hideFooterPagination?: boolean | undefined;
987
+ authors?: unknown;
988
+ lastUpdatedDate?: string | undefined;
989
+ createdDate?: string | undefined;
990
+ "openapi-schema"?: string | undefined;
991
+ icon?: string | {
992
+ name: string;
993
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
994
+ } | undefined;
995
+ tag?: string | undefined;
996
+ url?: string | undefined;
997
+ hideApiMarker?: boolean | undefined;
998
+ noindex?: boolean | undefined;
999
+ isPublic?: boolean | undefined;
2026
1000
  } | undefined;
2027
- api?: {
2028
- openapi?: string | string[] | {
2029
- source: string;
2030
- directory?: string | undefined;
2031
- } | undefined;
2032
- playground?: {
2033
- display?: "simple" | "none" | "interactive" | undefined;
2034
- proxy?: boolean | undefined;
2035
- } | undefined;
2036
- examples?: {
2037
- languages?: string[] | undefined;
1001
+ } & ({
1002
+ openapi: (string | string[] | {
1003
+ source: string;
1004
+ directory?: string | undefined;
1005
+ }) & (string | string[] | {
1006
+ source: string;
1007
+ directory?: string | undefined;
1008
+ } | undefined);
1009
+ } | {
1010
+ pages: any[];
1011
+ }))[];
1012
+ } | {
1013
+ pages: any[];
1014
+ })) | undefined);
1015
+ description?: string | undefined;
1016
+ logo?: string | {
1017
+ light: string;
1018
+ dark: string;
1019
+ href?: string | undefined;
1020
+ } | undefined;
1021
+ favicon?: string | {
1022
+ light: string;
1023
+ dark: string;
1024
+ } | undefined;
1025
+ api?: {
1026
+ openapi?: string | string[] | {
1027
+ source: string;
1028
+ directory?: string | undefined;
1029
+ } | undefined;
1030
+ playground?: {
1031
+ display?: "simple" | "none" | "interactive" | undefined;
1032
+ proxy?: boolean | undefined;
1033
+ } | undefined;
1034
+ examples?: {
1035
+ languages?: string[] | undefined;
1036
+ } | undefined;
1037
+ mdx?: {
1038
+ auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
1039
+ server?: string | string[] | undefined;
1040
+ } | undefined;
1041
+ } | undefined;
1042
+ appearance?: {
1043
+ default?: "light" | "dark" | "system" | undefined;
1044
+ strict?: boolean | undefined;
1045
+ } | undefined;
1046
+ background?: {
1047
+ image?: string | {
1048
+ light: string;
1049
+ dark: string;
1050
+ } | undefined;
1051
+ decoration?: "gradient" | "grid" | "windows" | undefined;
1052
+ color?: {
1053
+ light?: string | undefined;
1054
+ dark?: string | undefined;
1055
+ } | undefined;
1056
+ } | undefined;
1057
+ topbar?: {
1058
+ links?: {
1059
+ href: string;
1060
+ label: string;
1061
+ }[] | undefined;
1062
+ primary?: {
1063
+ type: "button";
1064
+ href: string;
1065
+ label: string;
1066
+ } | {
1067
+ type: "github";
1068
+ href: string;
1069
+ } | undefined;
1070
+ } | undefined;
1071
+ footer?: {
1072
+ socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
1073
+ links?: {
1074
+ items: {
1075
+ href: string;
1076
+ label: string;
1077
+ }[];
1078
+ header?: string | undefined;
1079
+ }[] | undefined;
1080
+ } | undefined;
1081
+ search?: {
1082
+ prompt?: string | undefined;
1083
+ } | undefined;
1084
+ seo?: {
1085
+ metatags?: Record<string, string> | undefined;
1086
+ indexing?: "all" | "navigable" | undefined;
1087
+ } | undefined;
1088
+ fonts?: {
1089
+ family: string;
1090
+ weight?: number | undefined;
1091
+ source?: string | undefined;
1092
+ format?: "woff" | "woff2" | undefined;
1093
+ } | {
1094
+ heading?: {
1095
+ family: string;
1096
+ weight?: number | undefined;
1097
+ source?: string | undefined;
1098
+ format?: "woff" | "woff2" | undefined;
1099
+ } | undefined;
1100
+ body?: {
1101
+ family: string;
1102
+ weight?: number | undefined;
1103
+ source?: string | undefined;
1104
+ format?: "woff" | "woff2" | undefined;
1105
+ } | undefined;
1106
+ } | undefined;
1107
+ icons?: {
1108
+ library: "fontawesome";
1109
+ } | undefined;
1110
+ styling?: {
1111
+ rounded?: "regular" | "sharp" | undefined;
1112
+ eyebrows?: "section" | "breadcrumbs" | undefined;
1113
+ codeblocks?: "dark" | "system" | undefined;
1114
+ } | undefined;
1115
+ redirects?: {
1116
+ source: string;
1117
+ destination: string;
1118
+ permanent?: boolean | undefined;
1119
+ }[] | undefined;
1120
+ integrations?: {
1121
+ amplitude?: {
1122
+ apiKey: string;
1123
+ } | undefined;
1124
+ clearbit?: {
1125
+ publicApiKey: string;
1126
+ } | undefined;
1127
+ fathom?: {
1128
+ siteId: string;
1129
+ } | undefined;
1130
+ frontchat?: {
1131
+ snippetId: string;
1132
+ } | undefined;
1133
+ ga4?: {
1134
+ measurementId: string;
1135
+ } | undefined;
1136
+ gtm?: {
1137
+ tagId: string;
1138
+ } | undefined;
1139
+ heap?: {
1140
+ appId: string;
1141
+ } | undefined;
1142
+ hotjar?: {
1143
+ hjid: string;
1144
+ hjsv: string;
1145
+ } | undefined;
1146
+ intercom?: {
1147
+ appId: string;
1148
+ } | undefined;
1149
+ koala?: {
1150
+ publicApiKey: string;
1151
+ } | undefined;
1152
+ logrocket?: {
1153
+ appId: string;
1154
+ } | undefined;
1155
+ mixpanel?: {
1156
+ projectToken: string;
1157
+ } | undefined;
1158
+ osano?: {
1159
+ scriptSource: string;
1160
+ } | undefined;
1161
+ pirsch?: {
1162
+ id: string;
1163
+ } | undefined;
1164
+ posthog?: {
1165
+ apiKey: string;
1166
+ apiHost?: string | undefined;
1167
+ } | undefined;
1168
+ plausible?: {
1169
+ domain: string;
1170
+ server?: string | undefined;
1171
+ } | undefined;
1172
+ segment?: {
1173
+ key: string;
1174
+ } | undefined;
1175
+ } | undefined;
1176
+ } | {
1177
+ name: string;
1178
+ $schema: string;
1179
+ theme: "willow";
1180
+ colors: {
1181
+ primary: string;
1182
+ light?: string | undefined;
1183
+ dark?: string | undefined;
1184
+ };
1185
+ navigation: ({
1186
+ global?: {
1187
+ languages?: ({
1188
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1189
+ hidden?: boolean | undefined;
1190
+ } & {
1191
+ href: string;
1192
+ })[] | undefined;
1193
+ versions?: ({
1194
+ version: string;
1195
+ hidden?: boolean | undefined;
1196
+ } & {
1197
+ href: string;
1198
+ })[] | undefined;
1199
+ tabs?: ({
1200
+ tab: string;
1201
+ icon?: string | {
1202
+ name: string;
1203
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1204
+ } | undefined;
1205
+ hidden?: boolean | undefined;
1206
+ } & {
1207
+ href: string;
1208
+ })[] | undefined;
1209
+ dropdowns?: ({
1210
+ dropdown: string;
1211
+ icon?: string | {
1212
+ name: string;
1213
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1214
+ } | undefined;
1215
+ hidden?: boolean | undefined;
1216
+ } & {
1217
+ href: string;
1218
+ })[] | undefined;
1219
+ anchors?: ({
1220
+ anchor: string;
1221
+ icon?: string | {
1222
+ name: string;
1223
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
2038
1224
  } | undefined;
2039
- mdx?: {
2040
- auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
2041
- server?: string | string[] | undefined;
1225
+ color?: {
1226
+ light?: string | undefined;
1227
+ dark?: string | undefined;
2042
1228
  } | undefined;
1229
+ hidden?: boolean | undefined;
1230
+ } & {
1231
+ href: string;
1232
+ })[] | undefined;
1233
+ } | undefined;
1234
+ } & ({
1235
+ languages: any[];
1236
+ } | {
1237
+ versions: any[];
1238
+ } | {
1239
+ tabs: any[];
1240
+ } | {
1241
+ dropdowns: any[];
1242
+ } | {
1243
+ anchors: any[];
1244
+ } | {
1245
+ groups: ({
1246
+ group: string;
1247
+ icon?: string | {
1248
+ name: string;
1249
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1250
+ } | undefined;
1251
+ hidden?: boolean | undefined;
1252
+ root?: string | {
1253
+ href: string;
1254
+ title: string;
1255
+ sidebarTitle?: string | undefined;
1256
+ description?: string | undefined;
1257
+ api?: string | undefined;
1258
+ openapi?: string | undefined;
1259
+ contentType?: string | undefined;
1260
+ authMethod?: string | undefined;
1261
+ auth?: string | undefined;
1262
+ version?: string | undefined;
1263
+ mode?: string | undefined;
1264
+ hideFooterPagination?: boolean | undefined;
1265
+ authors?: unknown;
1266
+ lastUpdatedDate?: string | undefined;
1267
+ createdDate?: string | undefined;
1268
+ "openapi-schema"?: string | undefined;
1269
+ icon?: string | {
1270
+ name: string;
1271
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1272
+ } | undefined;
1273
+ tag?: string | undefined;
1274
+ url?: string | undefined;
1275
+ hideApiMarker?: boolean | undefined;
1276
+ noindex?: boolean | undefined;
1277
+ isPublic?: boolean | undefined;
2043
1278
  } | undefined;
2044
- appearance?: {
2045
- default?: "light" | "dark" | "system" | undefined;
2046
- strict?: boolean | undefined;
2047
- } | undefined;
2048
- background?: {
2049
- image?: string | {
2050
- light: string;
2051
- dark: string;
1279
+ } & ({
1280
+ openapi: (string | string[] | {
1281
+ source: string;
1282
+ directory?: string | undefined;
1283
+ }) & (string | string[] | {
1284
+ source: string;
1285
+ directory?: string | undefined;
1286
+ } | undefined);
1287
+ } | {
1288
+ pages: any[];
1289
+ }))[];
1290
+ } | {
1291
+ pages: any[];
1292
+ })) & (({
1293
+ global?: {
1294
+ languages?: ({
1295
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1296
+ hidden?: boolean | undefined;
1297
+ } & {
1298
+ href: string;
1299
+ })[] | undefined;
1300
+ versions?: ({
1301
+ version: string;
1302
+ hidden?: boolean | undefined;
1303
+ } & {
1304
+ href: string;
1305
+ })[] | undefined;
1306
+ tabs?: ({
1307
+ tab: string;
1308
+ icon?: string | {
1309
+ name: string;
1310
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1311
+ } | undefined;
1312
+ hidden?: boolean | undefined;
1313
+ } & {
1314
+ href: string;
1315
+ })[] | undefined;
1316
+ dropdowns?: ({
1317
+ dropdown: string;
1318
+ icon?: string | {
1319
+ name: string;
1320
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1321
+ } | undefined;
1322
+ hidden?: boolean | undefined;
1323
+ } & {
1324
+ href: string;
1325
+ })[] | undefined;
1326
+ anchors?: ({
1327
+ anchor: string;
1328
+ icon?: string | {
1329
+ name: string;
1330
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
2052
1331
  } | undefined;
2053
- decoration?: "gradient" | "grid" | "windows" | undefined;
2054
1332
  color?: {
2055
1333
  light?: string | undefined;
2056
1334
  dark?: string | undefined;
2057
1335
  } | undefined;
1336
+ hidden?: boolean | undefined;
1337
+ } & {
1338
+ href: string;
1339
+ })[] | undefined;
1340
+ } | undefined;
1341
+ } & ({
1342
+ languages: any[];
1343
+ } | {
1344
+ versions: any[];
1345
+ } | {
1346
+ tabs: any[];
1347
+ } | {
1348
+ dropdowns: any[];
1349
+ } | {
1350
+ anchors: any[];
1351
+ } | {
1352
+ groups: ({
1353
+ group: string;
1354
+ icon?: string | {
1355
+ name: string;
1356
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1357
+ } | undefined;
1358
+ hidden?: boolean | undefined;
1359
+ root?: string | {
1360
+ href: string;
1361
+ title: string;
1362
+ sidebarTitle?: string | undefined;
1363
+ description?: string | undefined;
1364
+ api?: string | undefined;
1365
+ openapi?: string | undefined;
1366
+ contentType?: string | undefined;
1367
+ authMethod?: string | undefined;
1368
+ auth?: string | undefined;
1369
+ version?: string | undefined;
1370
+ mode?: string | undefined;
1371
+ hideFooterPagination?: boolean | undefined;
1372
+ authors?: unknown;
1373
+ lastUpdatedDate?: string | undefined;
1374
+ createdDate?: string | undefined;
1375
+ "openapi-schema"?: string | undefined;
1376
+ icon?: string | {
1377
+ name: string;
1378
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1379
+ } | undefined;
1380
+ tag?: string | undefined;
1381
+ url?: string | undefined;
1382
+ hideApiMarker?: boolean | undefined;
1383
+ noindex?: boolean | undefined;
1384
+ isPublic?: boolean | undefined;
2058
1385
  } | undefined;
2059
- topbar?: {
2060
- links?: {
2061
- href: string;
2062
- label: string;
2063
- }[] | undefined;
2064
- primary?: {
2065
- type: "button";
2066
- href: string;
2067
- label: string;
2068
- } | {
2069
- type: "github";
2070
- href: string;
2071
- } | undefined;
2072
- } | undefined;
2073
- footer?: {
2074
- socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
2075
- links?: {
2076
- items: {
2077
- href: string;
2078
- label: string;
2079
- }[];
2080
- header?: string | undefined;
2081
- }[] | undefined;
2082
- } | undefined;
2083
- search?: {
2084
- prompt?: string | undefined;
2085
- } | undefined;
2086
- seo?: {
2087
- metatags?: Record<string, string> | undefined;
2088
- indexing?: "all" | "navigable" | undefined;
2089
- } | undefined;
2090
- fonts?: {
2091
- family: string;
2092
- weight?: number | undefined;
2093
- source?: string | undefined;
2094
- format?: "woff" | "woff2" | undefined;
2095
- } | {
2096
- heading?: {
2097
- family: string;
2098
- weight?: number | undefined;
2099
- source?: string | undefined;
2100
- format?: "woff" | "woff2" | undefined;
1386
+ } & ({
1387
+ openapi: (string | string[] | {
1388
+ source: string;
1389
+ directory?: string | undefined;
1390
+ }) & (string | string[] | {
1391
+ source: string;
1392
+ directory?: string | undefined;
1393
+ } | undefined);
1394
+ } | {
1395
+ pages: any[];
1396
+ }))[];
1397
+ } | {
1398
+ pages: any[];
1399
+ })) | undefined);
1400
+ description?: string | undefined;
1401
+ logo?: string | {
1402
+ light: string;
1403
+ dark: string;
1404
+ href?: string | undefined;
1405
+ } | undefined;
1406
+ favicon?: string | {
1407
+ light: string;
1408
+ dark: string;
1409
+ } | undefined;
1410
+ api?: {
1411
+ openapi?: string | string[] | {
1412
+ source: string;
1413
+ directory?: string | undefined;
1414
+ } | undefined;
1415
+ playground?: {
1416
+ display?: "simple" | "none" | "interactive" | undefined;
1417
+ proxy?: boolean | undefined;
1418
+ } | undefined;
1419
+ examples?: {
1420
+ languages?: string[] | undefined;
1421
+ } | undefined;
1422
+ mdx?: {
1423
+ auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
1424
+ server?: string | string[] | undefined;
1425
+ } | undefined;
1426
+ } | undefined;
1427
+ appearance?: {
1428
+ default?: "light" | "dark" | "system" | undefined;
1429
+ strict?: boolean | undefined;
1430
+ } | undefined;
1431
+ background?: {
1432
+ image?: string | {
1433
+ light: string;
1434
+ dark: string;
1435
+ } | undefined;
1436
+ decoration?: "gradient" | "grid" | "windows" | undefined;
1437
+ color?: {
1438
+ light?: string | undefined;
1439
+ dark?: string | undefined;
1440
+ } | undefined;
1441
+ } | undefined;
1442
+ topbar?: {
1443
+ links?: {
1444
+ href: string;
1445
+ label: string;
1446
+ }[] | undefined;
1447
+ primary?: {
1448
+ type: "button";
1449
+ href: string;
1450
+ label: string;
1451
+ } | {
1452
+ type: "github";
1453
+ href: string;
1454
+ } | undefined;
1455
+ } | undefined;
1456
+ footer?: {
1457
+ socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
1458
+ links?: {
1459
+ items: {
1460
+ href: string;
1461
+ label: string;
1462
+ }[];
1463
+ header?: string | undefined;
1464
+ }[] | undefined;
1465
+ } | undefined;
1466
+ search?: {
1467
+ prompt?: string | undefined;
1468
+ } | undefined;
1469
+ seo?: {
1470
+ metatags?: Record<string, string> | undefined;
1471
+ indexing?: "all" | "navigable" | undefined;
1472
+ } | undefined;
1473
+ fonts?: {
1474
+ family: string;
1475
+ weight?: number | undefined;
1476
+ source?: string | undefined;
1477
+ format?: "woff" | "woff2" | undefined;
1478
+ } | {
1479
+ heading?: {
1480
+ family: string;
1481
+ weight?: number | undefined;
1482
+ source?: string | undefined;
1483
+ format?: "woff" | "woff2" | undefined;
1484
+ } | undefined;
1485
+ body?: {
1486
+ family: string;
1487
+ weight?: number | undefined;
1488
+ source?: string | undefined;
1489
+ format?: "woff" | "woff2" | undefined;
1490
+ } | undefined;
1491
+ } | undefined;
1492
+ icons?: {
1493
+ library: "fontawesome";
1494
+ } | undefined;
1495
+ styling?: {
1496
+ rounded?: "regular" | "sharp" | undefined;
1497
+ eyebrows?: "section" | "breadcrumbs" | undefined;
1498
+ codeblocks?: "dark" | "system" | undefined;
1499
+ } | undefined;
1500
+ redirects?: {
1501
+ source: string;
1502
+ destination: string;
1503
+ permanent?: boolean | undefined;
1504
+ }[] | undefined;
1505
+ integrations?: {
1506
+ amplitude?: {
1507
+ apiKey: string;
1508
+ } | undefined;
1509
+ clearbit?: {
1510
+ publicApiKey: string;
1511
+ } | undefined;
1512
+ fathom?: {
1513
+ siteId: string;
1514
+ } | undefined;
1515
+ frontchat?: {
1516
+ snippetId: string;
1517
+ } | undefined;
1518
+ ga4?: {
1519
+ measurementId: string;
1520
+ } | undefined;
1521
+ gtm?: {
1522
+ tagId: string;
1523
+ } | undefined;
1524
+ heap?: {
1525
+ appId: string;
1526
+ } | undefined;
1527
+ hotjar?: {
1528
+ hjid: string;
1529
+ hjsv: string;
1530
+ } | undefined;
1531
+ intercom?: {
1532
+ appId: string;
1533
+ } | undefined;
1534
+ koala?: {
1535
+ publicApiKey: string;
1536
+ } | undefined;
1537
+ logrocket?: {
1538
+ appId: string;
1539
+ } | undefined;
1540
+ mixpanel?: {
1541
+ projectToken: string;
1542
+ } | undefined;
1543
+ osano?: {
1544
+ scriptSource: string;
1545
+ } | undefined;
1546
+ pirsch?: {
1547
+ id: string;
1548
+ } | undefined;
1549
+ posthog?: {
1550
+ apiKey: string;
1551
+ apiHost?: string | undefined;
1552
+ } | undefined;
1553
+ plausible?: {
1554
+ domain: string;
1555
+ server?: string | undefined;
1556
+ } | undefined;
1557
+ segment?: {
1558
+ key: string;
1559
+ } | undefined;
1560
+ } | undefined;
1561
+ } | {
1562
+ name: string;
1563
+ $schema: string;
1564
+ theme: "linden";
1565
+ colors: {
1566
+ primary: string;
1567
+ light?: string | undefined;
1568
+ dark?: string | undefined;
1569
+ };
1570
+ navigation: ({
1571
+ global?: {
1572
+ languages?: ({
1573
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1574
+ hidden?: boolean | undefined;
1575
+ } & {
1576
+ href: string;
1577
+ })[] | undefined;
1578
+ versions?: ({
1579
+ version: string;
1580
+ hidden?: boolean | undefined;
1581
+ } & {
1582
+ href: string;
1583
+ })[] | undefined;
1584
+ tabs?: ({
1585
+ tab: string;
1586
+ icon?: string | {
1587
+ name: string;
1588
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1589
+ } | undefined;
1590
+ hidden?: boolean | undefined;
1591
+ } & {
1592
+ href: string;
1593
+ })[] | undefined;
1594
+ dropdowns?: ({
1595
+ dropdown: string;
1596
+ icon?: string | {
1597
+ name: string;
1598
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1599
+ } | undefined;
1600
+ hidden?: boolean | undefined;
1601
+ } & {
1602
+ href: string;
1603
+ })[] | undefined;
1604
+ anchors?: ({
1605
+ anchor: string;
1606
+ icon?: string | {
1607
+ name: string;
1608
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
2101
1609
  } | undefined;
2102
- body?: {
2103
- family: string;
2104
- weight?: number | undefined;
2105
- source?: string | undefined;
2106
- format?: "woff" | "woff2" | undefined;
1610
+ color?: {
1611
+ light?: string | undefined;
1612
+ dark?: string | undefined;
2107
1613
  } | undefined;
1614
+ hidden?: boolean | undefined;
1615
+ } & {
1616
+ href: string;
1617
+ })[] | undefined;
1618
+ } | undefined;
1619
+ } & ({
1620
+ languages: any[];
1621
+ } | {
1622
+ versions: any[];
1623
+ } | {
1624
+ tabs: any[];
1625
+ } | {
1626
+ dropdowns: any[];
1627
+ } | {
1628
+ anchors: any[];
1629
+ } | {
1630
+ groups: ({
1631
+ group: string;
1632
+ icon?: string | {
1633
+ name: string;
1634
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1635
+ } | undefined;
1636
+ hidden?: boolean | undefined;
1637
+ root?: string | {
1638
+ href: string;
1639
+ title: string;
1640
+ sidebarTitle?: string | undefined;
1641
+ description?: string | undefined;
1642
+ api?: string | undefined;
1643
+ openapi?: string | undefined;
1644
+ contentType?: string | undefined;
1645
+ authMethod?: string | undefined;
1646
+ auth?: string | undefined;
1647
+ version?: string | undefined;
1648
+ mode?: string | undefined;
1649
+ hideFooterPagination?: boolean | undefined;
1650
+ authors?: unknown;
1651
+ lastUpdatedDate?: string | undefined;
1652
+ createdDate?: string | undefined;
1653
+ "openapi-schema"?: string | undefined;
1654
+ icon?: string | {
1655
+ name: string;
1656
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1657
+ } | undefined;
1658
+ tag?: string | undefined;
1659
+ url?: string | undefined;
1660
+ hideApiMarker?: boolean | undefined;
1661
+ noindex?: boolean | undefined;
1662
+ isPublic?: boolean | undefined;
2108
1663
  } | undefined;
2109
- icons?: {
2110
- library: "fontawesome";
2111
- } | undefined;
2112
- styling?: {
2113
- rounded?: "regular" | "sharp" | undefined;
2114
- eyebrows?: "section" | "breadcrumbs" | undefined;
2115
- codeblocks?: "dark" | "system" | undefined;
2116
- } | undefined;
2117
- redirects?: {
1664
+ } & ({
1665
+ openapi: (string | string[] | {
2118
1666
  source: string;
2119
- destination: string;
2120
- permanent?: boolean | undefined;
2121
- }[] | undefined;
2122
- integrations?: {
2123
- amplitude?: {
2124
- apiKey: string;
2125
- } | undefined;
2126
- clearbit?: {
2127
- publicApiKey: string;
2128
- } | undefined;
2129
- fathom?: {
2130
- siteId: string;
2131
- } | undefined;
2132
- frontchat?: {
2133
- snippetId: string;
2134
- } | undefined;
2135
- ga4?: {
2136
- measurementId: string;
2137
- } | undefined;
2138
- gtm?: {
2139
- tagId: string;
2140
- } | undefined;
2141
- heap?: {
2142
- appId: string;
2143
- } | undefined;
2144
- hotjar?: {
2145
- hjid: string;
2146
- hjsv: string;
2147
- } | undefined;
2148
- intercom?: {
2149
- appId: string;
2150
- } | undefined;
2151
- koala?: {
2152
- publicApiKey: string;
2153
- } | undefined;
2154
- logrocket?: {
2155
- appId: string;
2156
- } | undefined;
2157
- mixpanel?: {
2158
- projectToken: string;
2159
- } | undefined;
2160
- osano?: {
2161
- scriptSource: string;
2162
- } | undefined;
2163
- pirsch?: {
2164
- id: string;
2165
- } | undefined;
2166
- posthog?: {
2167
- apiKey: string;
2168
- apiHost?: string | undefined;
2169
- } | undefined;
2170
- plausible?: {
2171
- domain: string;
2172
- server?: string | undefined;
1667
+ directory?: string | undefined;
1668
+ }) & (string | string[] | {
1669
+ source: string;
1670
+ directory?: string | undefined;
1671
+ } | undefined);
1672
+ } | {
1673
+ pages: any[];
1674
+ }))[];
1675
+ } | {
1676
+ pages: any[];
1677
+ })) & (({
1678
+ global?: {
1679
+ languages?: ({
1680
+ language: "en" | "cn" | "es" | "fr" | "jp" | "pt" | "pt-BR" | "de";
1681
+ hidden?: boolean | undefined;
1682
+ } & {
1683
+ href: string;
1684
+ })[] | undefined;
1685
+ versions?: ({
1686
+ version: string;
1687
+ hidden?: boolean | undefined;
1688
+ } & {
1689
+ href: string;
1690
+ })[] | undefined;
1691
+ tabs?: ({
1692
+ tab: string;
1693
+ icon?: string | {
1694
+ name: string;
1695
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1696
+ } | undefined;
1697
+ hidden?: boolean | undefined;
1698
+ } & {
1699
+ href: string;
1700
+ })[] | undefined;
1701
+ dropdowns?: ({
1702
+ dropdown: string;
1703
+ icon?: string | {
1704
+ name: string;
1705
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1706
+ } | undefined;
1707
+ hidden?: boolean | undefined;
1708
+ } & {
1709
+ href: string;
1710
+ })[] | undefined;
1711
+ anchors?: ({
1712
+ anchor: string;
1713
+ icon?: string | {
1714
+ name: string;
1715
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
2173
1716
  } | undefined;
2174
- segment?: {
2175
- key: string;
1717
+ color?: {
1718
+ light?: string | undefined;
1719
+ dark?: string | undefined;
2176
1720
  } | undefined;
1721
+ hidden?: boolean | undefined;
1722
+ } & {
1723
+ href: string;
1724
+ })[] | undefined;
1725
+ } | undefined;
1726
+ } & ({
1727
+ languages: any[];
1728
+ } | {
1729
+ versions: any[];
1730
+ } | {
1731
+ tabs: any[];
1732
+ } | {
1733
+ dropdowns: any[];
1734
+ } | {
1735
+ anchors: any[];
1736
+ } | {
1737
+ groups: ({
1738
+ group: string;
1739
+ icon?: string | {
1740
+ name: string;
1741
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1742
+ } | undefined;
1743
+ hidden?: boolean | undefined;
1744
+ root?: string | {
1745
+ href: string;
1746
+ title: string;
1747
+ sidebarTitle?: string | undefined;
1748
+ description?: string | undefined;
1749
+ api?: string | undefined;
1750
+ openapi?: string | undefined;
1751
+ contentType?: string | undefined;
1752
+ authMethod?: string | undefined;
1753
+ auth?: string | undefined;
1754
+ version?: string | undefined;
1755
+ mode?: string | undefined;
1756
+ hideFooterPagination?: boolean | undefined;
1757
+ authors?: unknown;
1758
+ lastUpdatedDate?: string | undefined;
1759
+ createdDate?: string | undefined;
1760
+ "openapi-schema"?: string | undefined;
1761
+ icon?: string | {
1762
+ name: string;
1763
+ style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
1764
+ } | undefined;
1765
+ tag?: string | undefined;
1766
+ url?: string | undefined;
1767
+ hideApiMarker?: boolean | undefined;
1768
+ noindex?: boolean | undefined;
1769
+ isPublic?: boolean | undefined;
2177
1770
  } | undefined;
2178
- };
2179
- }>;
2180
- readConfigFile: (configPath: string) => Promise<string>;
2181
- writeConfigFile: (config: MintConfig | DocsConfig, targetDir?: string) => Promise<void>;
2182
- private parseConfigJson;
2183
- }
2184
- export declare const MintConfigUpdater: ConfigUpdater;
2185
- export declare const DocsConfigUpdater: ConfigUpdater;
1771
+ } & ({
1772
+ openapi: (string | string[] | {
1773
+ source: string;
1774
+ directory?: string | undefined;
1775
+ }) & (string | string[] | {
1776
+ source: string;
1777
+ directory?: string | undefined;
1778
+ } | undefined);
1779
+ } | {
1780
+ pages: any[];
1781
+ }))[];
1782
+ } | {
1783
+ pages: any[];
1784
+ })) | undefined);
1785
+ description?: string | undefined;
1786
+ logo?: string | {
1787
+ light: string;
1788
+ dark: string;
1789
+ href?: string | undefined;
1790
+ } | undefined;
1791
+ favicon?: string | {
1792
+ light: string;
1793
+ dark: string;
1794
+ } | undefined;
1795
+ api?: {
1796
+ openapi?: string | string[] | {
1797
+ source: string;
1798
+ directory?: string | undefined;
1799
+ } | undefined;
1800
+ playground?: {
1801
+ display?: "simple" | "none" | "interactive" | undefined;
1802
+ proxy?: boolean | undefined;
1803
+ } | undefined;
1804
+ examples?: {
1805
+ languages?: string[] | undefined;
1806
+ } | undefined;
1807
+ mdx?: {
1808
+ auth?: "key" | "bearer" | "basic" | "cobo" | undefined;
1809
+ server?: string | string[] | undefined;
1810
+ } | undefined;
1811
+ } | undefined;
1812
+ appearance?: {
1813
+ default?: "light" | "dark" | "system" | undefined;
1814
+ strict?: boolean | undefined;
1815
+ } | undefined;
1816
+ background?: {
1817
+ image?: string | {
1818
+ light: string;
1819
+ dark: string;
1820
+ } | undefined;
1821
+ decoration?: "gradient" | "grid" | "windows" | undefined;
1822
+ color?: {
1823
+ light?: string | undefined;
1824
+ dark?: string | undefined;
1825
+ } | undefined;
1826
+ } | undefined;
1827
+ topbar?: {
1828
+ links?: {
1829
+ href: string;
1830
+ label: string;
1831
+ }[] | undefined;
1832
+ primary?: {
1833
+ type: "button";
1834
+ href: string;
1835
+ label: string;
1836
+ } | {
1837
+ type: "github";
1838
+ href: string;
1839
+ } | undefined;
1840
+ } | undefined;
1841
+ footer?: {
1842
+ socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter", string>> | undefined;
1843
+ links?: {
1844
+ items: {
1845
+ href: string;
1846
+ label: string;
1847
+ }[];
1848
+ header?: string | undefined;
1849
+ }[] | undefined;
1850
+ } | undefined;
1851
+ search?: {
1852
+ prompt?: string | undefined;
1853
+ } | undefined;
1854
+ seo?: {
1855
+ metatags?: Record<string, string> | undefined;
1856
+ indexing?: "all" | "navigable" | undefined;
1857
+ } | undefined;
1858
+ fonts?: {
1859
+ family: string;
1860
+ weight?: number | undefined;
1861
+ source?: string | undefined;
1862
+ format?: "woff" | "woff2" | undefined;
1863
+ } | {
1864
+ heading?: {
1865
+ family: string;
1866
+ weight?: number | undefined;
1867
+ source?: string | undefined;
1868
+ format?: "woff" | "woff2" | undefined;
1869
+ } | undefined;
1870
+ body?: {
1871
+ family: string;
1872
+ weight?: number | undefined;
1873
+ source?: string | undefined;
1874
+ format?: "woff" | "woff2" | undefined;
1875
+ } | undefined;
1876
+ } | undefined;
1877
+ icons?: {
1878
+ library: "fontawesome";
1879
+ } | undefined;
1880
+ styling?: {
1881
+ rounded?: "regular" | "sharp" | undefined;
1882
+ eyebrows?: "section" | "breadcrumbs" | undefined;
1883
+ codeblocks?: "dark" | "system" | undefined;
1884
+ } | undefined;
1885
+ redirects?: {
1886
+ source: string;
1887
+ destination: string;
1888
+ permanent?: boolean | undefined;
1889
+ }[] | undefined;
1890
+ integrations?: {
1891
+ amplitude?: {
1892
+ apiKey: string;
1893
+ } | undefined;
1894
+ clearbit?: {
1895
+ publicApiKey: string;
1896
+ } | undefined;
1897
+ fathom?: {
1898
+ siteId: string;
1899
+ } | undefined;
1900
+ frontchat?: {
1901
+ snippetId: string;
1902
+ } | undefined;
1903
+ ga4?: {
1904
+ measurementId: string;
1905
+ } | undefined;
1906
+ gtm?: {
1907
+ tagId: string;
1908
+ } | undefined;
1909
+ heap?: {
1910
+ appId: string;
1911
+ } | undefined;
1912
+ hotjar?: {
1913
+ hjid: string;
1914
+ hjsv: string;
1915
+ } | undefined;
1916
+ intercom?: {
1917
+ appId: string;
1918
+ } | undefined;
1919
+ koala?: {
1920
+ publicApiKey: string;
1921
+ } | undefined;
1922
+ logrocket?: {
1923
+ appId: string;
1924
+ } | undefined;
1925
+ mixpanel?: {
1926
+ projectToken: string;
1927
+ } | undefined;
1928
+ osano?: {
1929
+ scriptSource: string;
1930
+ } | undefined;
1931
+ pirsch?: {
1932
+ id: string;
1933
+ } | undefined;
1934
+ posthog?: {
1935
+ apiKey: string;
1936
+ apiHost?: string | undefined;
1937
+ } | undefined;
1938
+ plausible?: {
1939
+ domain: string;
1940
+ server?: string | undefined;
1941
+ } | undefined;
1942
+ segment?: {
1943
+ key: string;
1944
+ } | undefined;
1945
+ } | undefined;
1946
+ }>;