@@ -14,9 +14,8 @@ Every documentation site requires a `docs.json` file that contains the core conf
1414
1515### Customization
1616
17- <ResponseField name = " theme" type = ' "mint" | "maple" | "palm"' required >
18- The layout theme of the project. Examples:
19- [ Maple] ( https://maple.mintlify.app/ ) , [ Palm] ( https://palm.mintlify.app/ ) ,
17+ <ResponseField name = " theme" type = ' "mint" | "maple" | "palm" | "willow" | "linden"' required >
18+ The layout theme of the project. Check out the [ Themes] ( /themes ) page for more information.
2019</ResponseField >
2120
2221<ResponseField name = " name" type = " string" required >
@@ -105,7 +104,7 @@ Every documentation site requires a `docs.json` file that contains the core conf
105104 Icon library settings
106105
107106 <Expandable title = " Icons" >
108- <ResponseField name = " library" type = " " fontawesome" " required >
107+ <ResponseField name = " library" type = " " fontawesome" | " lucide " " required >
109108 The icon library to be used. Defaults to ` fontawesome ` .
110109 </ResponseField >
111110 </Expandable >
@@ -169,7 +168,7 @@ Every documentation site requires a `docs.json` file that contains the core conf
169168
170169 <Expandable title = " Appearance" >
171170 <ResponseField name = " default" type = " " system" | " light" | " dark" " >
172- The default light/dark mode. Defaults to system
171+ The default light/dark mode. Defaults to ` system `
173172 </ResponseField >
174173 <ResponseField name = " strict" type = " boolean" >
175174 Whether to hide the light / dark mode toggle. Defaults to ` true ` .
@@ -236,9 +235,10 @@ Every documentation site requires a `docs.json` file that contains the core conf
236235 <ResponseField name = " type" type = " " button" | " github" " required >
237236 </ResponseField >
238237 <ResponseField name = " label" type = " string" required >
238+ The label for the primary button. This only applies when ` type ` is set to ` button ` .
239239 </ResponseField >
240240 <ResponseField name = " href" type = " string (uri)" required >
241- A valid path or external link
241+ A valid path or external link. If ` type ` is set to ` github ` , this will be the URL to the repository.
242242 </ResponseField >
243243 </Expandable >
244244 </ResponseField >
@@ -257,7 +257,7 @@ Every documentation site requires a `docs.json` file that contains the core conf
257257 <ResponseField name = " languages" type = " array of object" >
258258
259259 <Expandable title = " Languages" >
260- <ResponseField name = " language" type = " " en" | " cn" | " es" | " fr" | " jp" | " pt" | " pt-BR" | " de" " required >
260+ <ResponseField name = " language" type = " " en" | " cn" | " zh " | " zh-Hans " | " zh-Hant " | " es" | " fr" | " ja " | " jp" | " pt" | " pt-BR" | " de" | " ko " | " it " | " ru " | " id " | " ar " | " tr " " required >
261261 The name of the language in the ISO 639-1 format
262262 </ResponseField >
263263 <ResponseField name = " default" type = " boolean" >
@@ -343,30 +343,54 @@ Every documentation site requires a `docs.json` file that contains the core conf
343343 </ResponseField >
344344 </Expandable >
345345 </ResponseField >
346+
347+ <ResponseField name = " dropdowns" type = " array of object" >
348+ <Expandable title = " Dropdowns" >
349+ <ResponseField name = " dropdown" type = " string" required >
350+ The name of the dropdown
351+
352+ Minimum length: 1
353+ </ResponseField >
354+ <ResponseField name = " icon" type = " string or object" >
355+ The icon to be displayed in the section
356+ </ResponseField >
357+ <ResponseField name = " hidden" type = " boolean" >
358+ Whether the current option is default hidden
359+ </ResponseField >
360+ <ResponseField name = " href" type = " string (uri)" required >
361+ An external link
362+ </ResponseField >
363+ </Expandable >
364+ </ResponseField >
346365 </Expandable >
347366 </ResponseField >
348367 <ResponseField name = " languages" type = " array of object" >
349- Organizing by languages
368+ Organizing by [ languages] ( /navigation/localization )
350369
351370 </ResponseField >
352371 <ResponseField name = " versions" type = " array of object" >
353- Organizing by versions
372+ Organizing by [ versions] ( /navigation/versions )
354373
355374 </ResponseField >
356375 <ResponseField name = " tabs" type = " array of object" >
357- Organizing by tabs
376+ Organizing by [ tabs] ( /navigation/divisions#tabs )
358377
359378 </ResponseField >
360379 <ResponseField name = " anchors" type = " array of object" >
361- Organizing by anchors
380+ Organizing by [ anchors] ( /navigation/divisions#anchors )
381+
382+ </ResponseField >
383+
384+ <ResponseField name = " dropdowns" type = " array of object" >
385+ Organizing by [ dropdowns] ( /navigation/divisions#dropdowns )
362386
363387 </ResponseField >
364388 <ResponseField name = " groups" type = " array of object" >
365- Organizing by groups
389+ Organizing by [ groups] ( /navigation/pages#pages )
366390
367391 </ResponseField >
368392 <ResponseField name = " pages" type = " array of string or object" >
369- An array of page paths or groups
393+ An array of [ page paths or groups] ( /navigation/pages#groups )
370394
371395 </ResponseField >
372396
@@ -385,7 +409,7 @@ Every documentation site requires a `docs.json` file that contains the core conf
385409 }
386410 ```
387411
388- Valid property names: bluesky, discord, facebook, github, hacker-news, instagram, linkedin, medium, podcast, reddit, slack, telegram, threads, twitter, website, x, youtube
412+ Valid property names: ` x ` , ` website ` , ` facebook ` , ` youtube ` , ` discord ` , ` slack ` , ` github ` , ` linkedin ` , ` instagram ` , ` hacker-news ` , ` medium ` , ` telegram ` , ` twitter ` , ` x- twitter` , ` earth-americas ` , ` bluesky ` , ` threads ` , ` reddit ` , ` podcast `
389413 </ResponseField >
390414 <ResponseField name = " links" type = " array of object" >
391415 The links to be displayed in the footer
@@ -448,7 +472,7 @@ Every documentation site requires a `docs.json` file that contains the core conf
448472
449473<ResponseField name = " contextual" type = " object" >
450474 <Expandable title = " Contextual" >
451- <ResponseField name = " options" type = " (' copy' | ' view' | ' chatgpt' | ' claude')[] " required >
475+ <ResponseField name = " options" type = " array of " copy" | " view" | " chatgpt" | " claude" " required >
452476 The options to be displayed in the contextual menu. The first option is the default option.
453477 - ` copy ` : Copy the current page as markdown to the clipboard
454478 - ` view ` : View the current page as markdown in a new tab
@@ -474,6 +498,19 @@ Every documentation site requires a `docs.json` file that contains the core conf
474498 A string or an array of strings of absolute or relative urls pointing to the OpenAPI file(s)
475499
476500 <Expandable title = " Openapi" >
501+ <ResponseField name = " source" type = " string" >
502+
503+ Minimum length: 1
504+ </ResponseField >
505+ <ResponseField name = " directory" type = " string" >
506+ no starting slash in the directory
507+ </ResponseField >
508+ </Expandable >
509+ </ResponseField >
510+ <ResponseField name = " asyncapi" type = " string or array or object" >
511+ A string or an array of strings of absolute or relative urls pointing to the AsyncAPI file(s)
512+
513+ <Expandable title = " Asyncapi" >
477514 <ResponseField name = " source" type = " string" >
478515
479516 Minimum length: 1
@@ -689,13 +726,26 @@ Every documentation site requires a `docs.json` file that contains the core conf
689726 </Expandable >
690727 </ResponseField >
691728 <ResponseField name = " segment" type = " object" >
692-
693729 <Expandable title = " Segment" >
694730 <ResponseField name = " key" type = " string" required >
695731 </ResponseField >
696732 </Expandable >
697733 </ResponseField >
698734
735+ <ResponseField name = " telemetry" type = " object" >
736+ <Expandable title = " Telemetry" >
737+ <ResponseField name = " enabled" type = " boolean" >
738+ </ResponseField >
739+ </Expandable >
740+ </ResponseField >
741+ <ResponseField name = " cookies" type = " object" >
742+ <Expandable title = " Cookies" >
743+ <ResponseField name = " key" type = " string" >
744+ </ResponseField >
745+ <ResponseField name = " value" type = " string" >
746+ </ResponseField >
747+ </Expandable >
748+ </ResponseField >
699749 </Expandable >
700750</ResponseField >
701751
0 commit comments