@mintlify/prebuild 1.0.318 → 1.0.320

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