@@ -33,6 +33,7 @@ settings. Learn more about the [properties](#properties) or from an
33
33
<ResponseField name = " href" type = " string" default = " /" >
34
34
Where clicking on the logo links you to
35
35
</ResponseField >
36
+
36
37
</Expandable >
37
38
</ResponseField >
38
39
@@ -71,6 +72,7 @@ settings. Learn more about the [properties](#properties) or from an
71
72
</ResponseField >
72
73
</Expandable >
73
74
</ResponseField >
75
+
74
76
</Expandable >
75
77
</ResponseField >
76
78
@@ -82,7 +84,11 @@ settings. Learn more about the [properties](#properties) or from an
82
84
[ Prism] ( https://starter-prism.mintlify.app )
83
85
</ResponseField >
84
86
85
- <ResponseField name = " layout" type = { ' "topnav" | "sidenav" | "solidSidenav"' } default = " topnav" >
87
+ <ResponseField
88
+ name = " layout"
89
+ type = { ' "topnav" | "sidenav" | "solidSidenav"' }
90
+ default = " topnav"
91
+ >
86
92
The global layout style of the documentation.
87
93
</ResponseField >
88
94
@@ -109,18 +115,18 @@ settings. Learn more about the [properties](#properties) or from an
109
115
Custom fonts. Apply globally or set different fonts for headings and the body
110
116
text.
111
117
112
- Example:
118
+ Example:
113
119
114
- ``` json
115
- "font" : {
116
- "headings" : {
117
- "family" : " Roboto"
118
- },
119
- "body" : {
120
- "family" : " Oswald"
121
- }
120
+ ``` json
121
+ "font" : {
122
+ "headings" : {
123
+ "family" : " Roboto"
124
+ },
125
+ "body" : {
126
+ "family" : " Oswald"
122
127
}
123
- ```
128
+ }
129
+ ```
124
130
125
131
<Expandable title = " FontDetailsType" >
126
132
<ResponseField name = " family" type = " string" required >
@@ -143,6 +149,7 @@ settings. Learn more about the [properties](#properties) or from an
143
149
<ResponseField name = " format" type = " 'woff' | 'woff2'" >
144
150
The font format. Required if using a custom font source (` url ` ).
145
151
</ResponseField >
152
+
146
153
</Expandable >
147
154
</ResponseField >
148
155
@@ -174,6 +181,7 @@ settings. Learn more about the [properties](#properties) or from an
174
181
```
175
182
</CodeGroup >
176
183
</ResponseField >
184
+
177
185
</Expandable >
178
186
</ResponseField >
179
187
@@ -243,6 +251,7 @@ settings. Learn more about the [properties](#properties) or from an
243
251
<ResponseField name = " iconType" type = " string" >
244
252
The type of [ Fontawesome] ( https://fontawesome.com/icons ) icon. Must be one of: brands, duotone, light, sharp-solid, solid, thin
245
253
</ResponseField >
254
+
246
255
</Expandable >
247
256
</ResponseField >
248
257
@@ -257,6 +266,7 @@ settings. Learn more about the [properties](#properties) or from an
257
266
<ResponseField name = " url" type = " string" >
258
267
The url once you click on the button. Example: ` https://mintlify.com/contact `
259
268
</ResponseField >
269
+
260
270
</Expandable >
261
271
</ResponseField >
262
272
@@ -283,23 +293,29 @@ settings. Learn more about the [properties](#properties) or from an
283
293
<ResponseField name = " arrow" type = " boolean" >
284
294
Whether to display the arrow
285
295
</ResponseField >
296
+
286
297
</Expandable >
287
298
</ResponseField >
288
299
289
300
<ResponseField name = " versions" type = " string[]" >
290
301
Array of version names. Only use this if you want to show different versions
291
302
of docs with a dropdown in the navigation bar.
292
303
293
- Versions can be leveraged for localization. You can store translated content
294
- under a version, and once you specify the ` locale ` any fixed text in Mintlify,
295
- such as 'Was this page helpful?', will automatically be translated based on the
296
- locale. We currently support localization in English, Chinese, Spanish, French,
297
- Japanese, and Portuguese.
304
+ Versions can be leveraged for localization. You can store translated content
305
+ under a version, and once you specify the ` locale ` any fixed text in Mintlify,
306
+ such as 'Was this page helpful?', will automatically be translated based on the
307
+ locale. We currently support localization in English, Chinese, Spanish, French,
308
+ Japanese, and Portuguese.
298
309
299
- For more information, please refer to our
300
- [ versioning documentation] ( /settings/versioning ) .
310
+ <Info >
311
+ Localization applies to the UI and fixed assets in the docs, such as "was this
312
+ page helpful".
313
+ </Info >
301
314
302
- Example:
315
+ For more information, please refer to our
316
+ [ versioning documentation] ( /settings/versioning ) .
317
+
318
+ Example:
303
319
304
320
<CodeGroup >
305
321
``` json Default
@@ -318,6 +334,7 @@ settings. Learn more about the [properties](#properties) or from an
318
334
}
319
335
]
320
336
```
337
+
321
338
</CodeGroup >
322
339
323
340
<Expandable title = " Version" >
@@ -332,15 +349,24 @@ settings. Learn more about the [properties](#properties) or from an
332
349
<ResponseField name = " default" type = " true" >
333
350
Whether the version is the default version. Handy for when you have a "latest" and "stable" version and you want to default to the stable version.
334
351
</ResponseField >
352
+
335
353
</Expandable >
336
354
</ResponseField >
337
355
338
356
<ResponseField name = " anchors" type = " Anchor[]" >
339
357
An array of the anchors, includes the icon, color, and url.
340
358
341
- <img className = " block h-32 dark:hidden" src = " https://mintlify-assets.b-cdn.net/anchors-light.png" />
359
+ { " " }
360
+ <img
361
+ className = " block h-32 dark:hidden"
362
+ src = " https://mintlify-assets.b-cdn.net/anchors-light.png"
363
+ />
342
364
343
- <img className = " hidden h-32 dark:block" src = " https://mintlify-assets.b-cdn.net/anchors-dark.png" />
365
+ { " " }
366
+ <img
367
+ className = " hidden h-32 dark:block"
368
+ src = " https://mintlify-assets.b-cdn.net/anchors-dark.png"
369
+ />
344
370
345
371
<Expandable title = " Anchor" >
346
372
<ResponseField name = " name" type = " string" required >
@@ -374,6 +400,7 @@ settings. Learn more about the [properties](#properties) or from an
374
400
<ResponseField name = " iconType" default = " duotone" type = " string" >
375
401
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
376
402
</ResponseField >
403
+
377
404
</Expandable >
378
405
</ResponseField >
379
406
@@ -393,26 +420,27 @@ settings. Learn more about the [properties](#properties) or from an
393
420
<ResponseField name = " iconType" default = " duotone" type = " string" >
394
421
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
395
422
</ResponseField >
423
+
396
424
</Expandable >
397
425
</ResponseField >
398
426
399
427
<ResponseField name = " tabs" type = " Tabs[]" >
400
428
An array of navigational tabs.
401
429
402
- Example:
430
+ Example:
403
431
404
- ``` json
405
- "tabs" : [
406
- {
407
- "name" : " Writing Content" ,
408
- "url" : " content"
409
- },
410
- {
411
- "name" : " API References" ,
412
- "url" : " api-playground"
413
- }
414
- ]
415
- ```
432
+ ``` json
433
+ "tabs" : [
434
+ {
435
+ "name" : " Writing Content" ,
436
+ "url" : " content"
437
+ },
438
+ {
439
+ "name" : " API References" ,
440
+ "url" : " api-playground"
441
+ }
442
+ ]
443
+ ```
416
444
417
445
<Expandable title = " Tabs" >
418
446
<ResponseField name = " name" type = " string" >
@@ -427,34 +455,35 @@ settings. Learn more about the [properties](#properties) or from an
427
455
<ResponseField name = " isDefaultHidden" type = " boolean" default = { false } >
428
456
Pass ` true ` if you want to hide the tab until you directly link someone to docs inside it.
429
457
</ResponseField >
458
+
430
459
</Expandable >
431
460
</ResponseField >
432
461
433
462
<ResponseField name = " footer" type = " { socials?: FooterSocials, links?: FooterLinksColumn[] }" >
434
463
An object to configure the footer with socials and links.
435
464
Example:
436
465
437
- ``` json
438
- "footer" : {
439
- "socials" : { "x" : " https://x.com/mintlify" , "website" : " https://mintlify.com" },
440
- "links" : [
441
- {
442
- "title" : " Column 1" ,
443
- "links" : [
444
- { "label" : " Column 1 Link 1" , "url" : " https://mintlify.com" },
445
- { "label" : " Column 1 Link 2" , "url" : " https://mintlify.com" }
446
- ]
447
- },
448
- {
449
- "title" : " Column 2" ,
450
- "links" : [
451
- { "label" : " Column 2 Link 1" , "url" : " https://mintlify.com" },
452
- { "label" : " Column 2 Link 2" , "url" : " https://mintlify.com" }
453
- ]
454
- }
455
- ]
456
- }
457
- ```
466
+ ``` json
467
+ "footer" : {
468
+ "socials" : { "x" : " https://x.com/mintlify" , "website" : " https://mintlify.com" },
469
+ "links" : [
470
+ {
471
+ "title" : " Column 1" ,
472
+ "links" : [
473
+ { "label" : " Column 1 Link 1" , "url" : " https://mintlify.com" },
474
+ { "label" : " Column 1 Link 2" , "url" : " https://mintlify.com" }
475
+ ]
476
+ },
477
+ {
478
+ "title" : " Column 2" ,
479
+ "links" : [
480
+ { "label" : " Column 2 Link 1" , "url" : " https://mintlify.com" },
481
+ { "label" : " Column 2 Link 2" , "url" : " https://mintlify.com" }
482
+ ]
483
+ }
484
+ ]
485
+ }
486
+ ```
458
487
459
488
<Expandable title = " FooterSocials" >
460
489
<ResponseField name = " [key]" type = " string" >
@@ -468,6 +497,7 @@ settings. Learn more about the [properties](#properties) or from an
468
497
469
498
Example: ` https://x.com/mintlify `
470
499
</ResponseField >
500
+
471
501
</Expandable >
472
502
473
503
<Expandable title = " FooterLinksColumn" >
@@ -478,6 +508,7 @@ settings. Learn more about the [properties](#properties) or from an
478
508
<ResponseField name = " links" type = " { label: string, url: string }[]" >
479
509
The link items in the column. External urls that starts with ` https:// ` or ` http:// ` will be opened in new tab.
480
510
</ResponseField >
511
+
481
512
</Expandable >
482
513
</ResponseField >
483
514
@@ -496,6 +527,7 @@ settings. Learn more about the [properties](#properties) or from an
496
527
<ResponseField name = " raiseIssue" type = " boolean" default = { false } >
497
528
Enables a button to allow users to raise an issue about the documentation
498
529
</ResponseField >
530
+
499
531
</Expandable >
500
532
</ResponseField >
501
533
@@ -591,14 +623,15 @@ settings. Learn more about the [properties](#properties) or from an
591
623
</ResponseField >
592
624
</Expandable >
593
625
</ResponseField >
626
+
594
627
</Expandable >
595
628
</ResponseField >
596
629
597
630
<ResponseField name = " openapi" type = " string | string[]" >
598
631
A string or an array of strings of URL(s) or relative path(s) pointing to your
599
632
OpenAPI file.
600
633
601
- Examples:
634
+ Examples:
602
635
603
636
<CodeGroup >
604
637
``` json Absolute
@@ -612,6 +645,7 @@ settings. Learn more about the [properties](#properties) or from an
612
645
``` json Multiple
613
646
"openapi" : [" https://example.com/openapi1.json" , " /openapi2.json" , " /openapi3.json" ]
614
647
```
648
+
615
649
</CodeGroup >
616
650
</ResponseField >
617
651
@@ -628,6 +662,7 @@ settings. Learn more about the [properties](#properties) or from an
628
662
<ResponseField name = " frontchat" type = " string" >
629
663
Enables Frontchat widget on docs site. The value should be your Frontchat App ID.
630
664
</ResponseField >
665
+
631
666
</Expandable >
632
667
</ResponseField >
633
668
@@ -641,16 +676,16 @@ settings. Learn more about the [properties](#properties) or from an
641
676
<ResponseField name = " redirects" type = " Redirect[]" >
642
677
An array of paths you want to configure to permanently redirect to another path
643
678
644
- Example:
679
+ Example:
645
680
646
- ``` json
647
- "redirects" : [
648
- {
649
- "source" : " /source/path" ,
650
- "destination" : " /destination/path"
651
- }
652
- ]
653
- ```
681
+ ``` json
682
+ "redirects" : [
683
+ {
684
+ "source" : " /source/path" ,
685
+ "destination" : " /destination/path"
686
+ }
687
+ ]
688
+ ```
654
689
655
690
<Expandable title = " Redirect" >
656
691
<ResponseField name = " source" type = " string" >
@@ -664,6 +699,7 @@ settings. Learn more about the [properties](#properties) or from an
664
699
665
700
Example: ` /destination `
666
701
</ResponseField >
702
+
667
703
</Expandable >
668
704
</ResponseField >
669
705
@@ -672,13 +708,13 @@ settings. Learn more about the [properties](#properties) or from an
672
708
<ResponseField name = " seo" type = " SEO" >
673
709
Settings for Search Engine Optimization.
674
710
675
- Example:
711
+ Example:
676
712
677
- ``` json
678
- "seo" : {
679
- "indexHiddenPages" : true
680
- }
681
- ```
713
+ ``` json
714
+ "seo" : {
715
+ "indexHiddenPages" : true
716
+ }
717
+ ```
682
718
683
719
<Expandable title = " Redirect" >
684
720
<ResponseField name = " indexHiddenPages" type = " boolean" default = " false" >
@@ -763,4 +799,4 @@ Click on the following dropdown to view a sample configuration file
763
799
## More Customization
764
800
765
801
Learn more about how to further customize your docs with custom CSS and JS in
766
- [ Custom Scripts] ( https://mintlify.com/docs/advanced/custom/ ) .
802
+ [ Custom Scripts] ( https://mintlify.com/docs/advanced/custom/ ) .
0 commit comments