Mintlify gives you complete control over the look and feel of your documentation using the docs.json file
Every Mintlify site needs a docs.json file with the core configuration settings. Learn more about the properties below.
Properties
string
required
Name of your project. Used for the global title.Example: mintlify
Navigation[]
required
An array of groups with all the pages within that group
Show Navigation
string
The name of the group.Example: Settings
string[]
The relative paths to the markdown files that will serve as pages.Example: ["customization", "page"]
string or object
Path to logo image or object with path to “light” and “dark” mode logo images
Show Logo
string
Path to the logo in light mode
string
Path to the logo in dark mode
string
default:"/"
Where clicking on the logo links you to
string
Path to the favicon image
Colors
Hex color codes for your global theme
Show Colors
string
required
The primary color. Used for most often for highlighted content, section
headers, accents, in light mode
string
The primary color for dark mode. Used for most often for highlighted
content, section headers, accents, in dark mode
string
The primary color for important buttons
object
The color of the background in both light and dark mode
Show Object
string
required
The hex color code of the background in light mode
string
required
The hex color code of the background in dark mode
TopbarLink[]
Array of names and urls of links you want to include in the topbar
Show TopbarLink
string
The name of the button.Example: Contact us
string
The url once you click on the button. Example: https://mintlify.com/docs
Call to Action
Show Topbar Call to Action
"link" or "github"
default:"link"
Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
string
If link: What the button links to.If github: Link to the repository to load GitHub information from.
string
Text inside the button. Only required if type is a link.
string[]
Array of version names. Only use this if you want to show different versions
of docs with a dropdown in the navigation bar.
Anchor[]
An array of the anchors, includes the icon, color, and url.
Show Anchor
string
The Font Awesome icon used to feature the anchor.Example: comments
string
The name of the anchor label.Example: Community
string
The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.
string
The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties from and to that are each a hex color.
string
Used if you want to hide an anchor until the correct docs version is selected.
boolean
default:"false"
Pass true if you want to hide the anchor until you directly link someone to docs inside it.
string
default:"duotone"
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
Object
Override the default configurations for the top-most anchor.
Show Object
string
default:"Documentation"
The name of the top-most anchor
string
default:"book-open"
Font Awesome icon.
string
default:"duotone"
One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”
Tabs[]
An array of navigational tabs.
Show Tabs
string
The name of the tab label.
string
The start of the URL that marks what pages go in the tab. Generally, this
is the name of the folder you put your pages in.
API
Configuration for API settings. Learn more about API pages at API Components.
Show API
string
The base url for all API endpoints. If baseUrl is an array, it will enable for multiple base url
options that the user can toggle.
Auth
Show Auth
"bearer" | "basic" | "key"
The authentication strategy used for all API endpoints.
string
The name of the authentication parameter used in the API playground.If method is basic, the format should be [usernameName]:[passwordName]
string
The default value that’s designed to be a prefix for the authentication input field.E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
Playground
Configurations for the API playground
Show Playground
"show" | "simple" | "hide"
default:"show"
Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity simpleLearn more at the playground guides
boolean
Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.
This behavior will soon be enabled by default, at which point this field will be deprecated.
string | string[]
A string or an array of strings of URL(s) or relative path(s) pointing to your
OpenAPI file.Examples:
A background image to be displayed behind every page. See example with
Infisical and FRPC.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"FrenFlow","description":"Prediction Markets, Together 🔮","colors":{"primary":"#baf820","light":"#baf820","dark":"#baf820"},"logo":"https://mintcdn.com/frenflow/P3ppkZGEivxpUD4h/images/frenflow_logo.png?fit=max\u0026auto=format\u0026n=P3ppkZGEivxpUD4h\u0026q=85\u0026s=50538051f7e174e88700f0981d1ef567","favicon":"/images/frenflow_logo.png","appearance":{"default":"dark","strict":true},"background":{"color":{"dark":"#0f0f12"}},"navbar":{"links":[{"icon":"book-open","href":"/guides/getting-started","label":"Guides"}]},"footer":{"socials":{"x":"https://x.com/frenflow","website":"https://www.frenflow.com","telegram":"https://t.me/frenflow_announcements"},"links":[{"header":"Trade with your frens","items":[{"label":"frenflow.com","href":"https://frenflow.com"}]}]},"seo":{"metatags":{"og:site_name":"FrenFlow Docs","og:locale":"en_US","og:type":"website","og:description":"Learn how to trade prediction markets, copy top traders, and earn rewards on FrenFlow.","twitter:card":"summary_large_image","twitter:site":"@frenflow","twitter:creator":"@frenflow"},"indexing":"all"},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"integrations":{"ga4":{"measurementId":"G-JMJ3F366N8"}},"banner":{"content":"\u003cspan style='display:inline-block;width:8px;height:8px;background:#ef4444;border-radius:50%;margin-right:6px;animation:pulse 2s infinite;vertical-align:middle'>\u003c/span> FrenFlow is live — start trading prediction markets with your frens at [frenflow.com](https://frenflow.com)","dismissible":true},"errors":{"404":{"redirect":true}},"thumbnails":{"appearance":"dark"},"variables":{"version":"2.0.0","api-url":"https://api.example.com"},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"frenflow","hasAudioNarration":false,"actualSubdomain":"frenflow","customDomains":["docs.frenflow.com"],"gitSource":{"type":"github","owner":"frenflow","repo":"docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"entitlements":{},"buildId":"6ae949fe3a5425ee311e2835:success","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Guides — Web","count":10},{"language":"default","tag":"Markets","count":6},{"language":"default","tag":"Trading","count":6},{"language":"default","tag":"Copy Trading","count":5},{"language":"default","tag":"Guides — Telegram","count":4},{"language":"default","tag":"Social","count":4},{"language":"default","tag":"Wallet","count":4},{"language":"default","tag":"Affiliate","count":3},{"language":"default","tag":"Fren Points","count":3},{"language":"default","tag":"Leaderboard","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"#banner,#banner *,#banner a,#banner p,#banner span{color:#000000!important}[data-name=\"frame\"].frame{border:0!important;outline:0!important;box-shadow:0 1px 8px rgba(255, 255, 255, 0.03)!important;border-color:transparent!important;background:transparent!important;padding:0!important;ring:0!important;border-radius:0!important;margin-top:2rem!important;margin-bottom:-1rem!important}[data-name=\"frame\"].frame>*,[data-name=\"frame\"].frame span,[data-name=\"frame\"].frame div,[data-name=\"frame\"].frame img{border:0!important;outline:0!important;box-shadow:none!important;border-color:transparent!important;ring:0!important;border-radius:0!important}.navbar-link a[href=\"/guides/getting-started\"]{background-color:#baf820!important;color:#000000!important;border-radius:8px!important;padding:6px 16px!important;font-weight:600!important;text-decoration:none!important}.navbar-link a[href=\"/guides/getting-started\"]:hover{background-color:#a8e010!important;color:#000000!important}.text-green{color:#22c55e!important}.text-red{color:#ef4444!important}.navbar-link a[href=\"/guides/getting-started\"] svg{background-color:#000000!important}div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]){display:none!important}#navigation-items:has(li[id^=\"/guides/\"] a[class*=\"bg-primary\"]),#navigation-items:has(li[id^=\"/guides/\"] a.text-primary),#navigation-items:has(li[id^=\"/guides/\"] a.font-semibold){display:flex!important;flex-direction:column!important}#navigation-items:has(li[id^=\"/guides/\"] a[class*=\"bg-primary\"]) div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]),#navigation-items:has(li[id^=\"/guides/\"] a.text-primary) div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]),#navigation-items:has(li[id^=\"/guides/\"] a.font-semibold) div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]){display:block!important;order:-1!important}#navigation-items:has(li[id^=\"/guides/\"] a[class*=\"bg-primary\"])>div:first-child,#navigation-items:has(li[id^=\"/guides/\"] a.text-primary)>div:first-child,#navigation-items:has(li[id^=\"/guides/\"] a.font-semibold)>div:first-child{display:block!important;order:-2!important}#navigation-items:has(li[id^=\"/guides/\"] a[class*=\"bg-primary\"]) div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]):last-of-type,#navigation-items:has(li[id^=\"/guides/\"] a.text-primary) div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]):last-of-type,#navigation-items:has(li[id^=\"/guides/\"] a.font-semibold) div:has(>.sidebar-group-header):has(ul.sidebar-group li[id^=\"/guides/\"]):last-of-type{margin-bottom:1.5rem!important}.sidebar-group-header h5#sidebar-title{color:#ffffff!important}div:has(>ul.sidebar-group li[id^=\"/guides/\"])>.sidebar-group-header h5#sidebar-title{color:#baf820!important}#sidebar-content .sidebar-group li a{color:#A1A1AA!important}#sidebar-content .sidebar-group li a{transition:color 0.2s ease!important;background:linear-gradient(to right, rgba(255, 255, 255, 0.08), rgba(255, 255, 255, 0.08)) no-repeat left/0% 100%!important;transition:background-size 0.3s ease, color 0.2s ease!important}#sidebar-content .sidebar-group li a:hover{color:#ffffff!important;background-size:100% 100%!important;border-radius:0.75rem!important}#sidebar-content .sidebar-group li a.text-primary,#sidebar-content .sidebar-group li a[class*=\"bg-primary\"]{background-color:#ffffff!important;color:#111111!important;font-weight:600!important}#sidebar-content .sidebar-group li a[class*=\"bg-primary\"] svg,#sidebar-content .sidebar-group li a.text-primary svg{background-color:#111111!important}#sidebar-content .sidebar-group li a svg{background-color:#A1A1AA!important}footer#footer>div{padding-top:2rem!important;padding-bottom:2rem!important;gap:1.5rem!important}footer#footer a[href*=\"mintlify.com\"],footer#footer .h-\\[1px\\],footer#footer>div>div:last-child{display:none!important}footer#footer .flex.flex-col.md\\:flex-row>div:first-child>a{display:none!important}footer#footer .flex.flex-col.sm\\:grid{display:none!important}footer#footer .flex.flex-col.md\\:flex-row{flex-direction:column!important;align-items:center!important;justify-content:center!important}footer#footer .flex.flex-col.md\\:flex-row>div:first-child{min-width:0!important;width:auto!important}footer#footer .flex.flex-col.md\\:flex-row>div:last-child{display:none!important}footer#footer .flex.gap-4.min-w-\\[140px\\].md\\:hidden{display:flex!important;justify-content:center!important}#sidebar-content::-webkit-scrollbar{width:4px}#sidebar-content::-webkit-scrollbar-track{background:transparent}#sidebar-content::-webkit-scrollbar-thumb{background-color:#ffffff;border-radius:4px}#sidebar-content{scrollbar-color:#ffffff transparent;scrollbar-width:thin}*::-webkit-scrollbar{width:4px;height:4px}*::-webkit-scrollbar-track{background:transparent}*::-webkit-scrollbar-thumb{background-color:#baf820;border-radius:4px}html{scrollbar-color:#baf820 transparent;scrollbar-width:thin}@media (max-width: 1023px){#sidebar-content::-webkit-scrollbar-thumb,#navigation-items::-webkit-scrollbar-thumb,div.lg\\:hidden::-webkit-scrollbar-thumb,div.lg\\:hidden *::-webkit-scrollbar-thumb{background-color:#ffffff!important}#sidebar-content,#navigation-items,div.lg\\:hidden,div.lg\\:hidden *{scrollbar-color:#ffffff transparent!important}}a.card [data-component-part=\"card-content-container\"],.card [data-component-part=\"card-content-container\"]{display:grid!important;grid-template-columns:auto 1fr!important;gap:0 10px!important}a.card [data-component-part=\"card-icon\"],.card [data-component-part=\"card-icon\"]{grid-column:1!important;grid-row:1!important;align-self:center!important}a.card [data-component-part=\"card-content-container\"]>div:last-child,.card [data-component-part=\"card-content-container\"]>div:last-child{display:contents!important}a.card [data-component-part=\"card-title\"],.card [data-component-part=\"card-title\"]{grid-column:2!important;grid-row:1!important;margin-top:0!important;align-self:center!important}a.card [data-component-part=\"card-content\"],.card [data-component-part=\"card-content\"]{grid-column:1 / -1!important;grid-row:2!important;margin-top:8px!important}a:has(.nav-logo){display:inline-flex!important;align-items:center!important;flex-direction:row!important;white-space:nowrap!important}a:has(.nav-logo){order:-1!important}a:has(.nav-logo)::before{content:\"FREN\"!important;font-family:\"Inter\", sans-serif!important;font-weight:800!important;font-size:1.1rem!important;color:#ffffff!important;margin-left:8px!important;letter-spacing:0.05em!important;order:2!important}a:has(.nav-logo)::after{content:\"DOCS\"!important;font-family:\"Inter\", sans-serif!important;font-weight:400!important;font-size:1.1rem!important;color:#ffffff!important;letter-spacing:0.05em!important;order:3!important}a:has(.nav-logo) .nav-logo{order:1!important}.prose table{border-collapse:separate!important;border-spacing:0!important;border-radius:12px!important;overflow:hidden!important;border:1px solid rgba(255, 255, 255, 0.06)!important}.prose table thead tr{background-color:rgba(186, 248, 32, 0.08)!important}.prose table thead th{color:#baf820!important;font-weight:600!important;border-bottom:1px solid rgba(186, 248, 32, 0.15)!important;padding:12px 16px!important}.prose table tbody tr{border-bottom:1px solid rgba(255, 255, 255, 0.04)!important;transition:background-color 0.2s ease!important}.prose table tbody tr:hover{background-color:rgba(255, 255, 255, 0.03)!important}.prose table tbody td{padding:10px 16px!important;border-bottom:1px solid rgba(255, 255, 255, 0.04)!important}.prose table tbody tr:last-child td{border-bottom:none!important}#assistant-entry-mobile,#assistant-entry,.chat-assistant-floating-input,div:has(>.chat-assistant-floating-input){display:none!important}button[aria-label=\"More actions\"]{display:none!important}@media (max-width: 1023px){#navbar .hidden.lg\\:flex.items-center.ml-auto{display:flex!important;flex:0!important;margin-left:0!important}#navbar .hidden.lg\\:flex.items-center.ml-auto>.flex.items-center:empty{display:none!important}}.navbar-link a[href=\"/guides/getting-started\"]{display:inline-flex!important;font-size:0.8rem!important;padding:4px 12px!important}button.lg\\:hidden svg[viewBox=\"0 0 448 512\"]{height:1.25rem!important;width:1.25rem!important}#pagination{padding-top:1rem!important;padding-bottom:1.5rem!important;margin-top:1.5rem!important;gap:1rem!important}@media (max-width: 767px){footer#footer .flex.flex-col.md\\:flex-row>div:first-child{align-items:center!important;justify-content:center!important}footer#footer .flex.flex-col.md\\:flex-row>div:first-child>.flex.gap-4{justify-content:center!important;width:100%!important}}@keyframes pulse{0%,100%{opacity:1;box-shadow:0 0 0 0 rgba(239, 68, 68, 0.7)}50%{opacity:0.8;box-shadow:0 0 0 4px rgba(239, 68, 68, 0)}}"}],"page":{"pagePath":"essentials/settings","slug":"/essentials/settings","pageMetadata":{"title":"Global Settings","description":"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file","icon":"gear","href":"/essentials/settings","hidden":false},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Expandable,Heading,ResponseField,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ResponseField)_missingMdxReference(`ResponseField`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Every Mintlify site needs a `,_jsx(_components.code,{children:`docs.json`}),` file with the core configuration settings. Learn more about the `,_jsx(_components.a,{href:`#properties`,children:`properties`}),` below.`]}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsxs(ResponseField,{name:`name`,type:`string`,required:true,id:`param-name`,children:[_jsx(_components.p,{children:`Name of your project. Used for the global title.`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`mintlify`})]})]}),`\n`,_jsxs(ResponseField,{name:`navigation`,type:`Navigation[]`,required:true,id:`param-navigation`,children:[_jsx(_components.p,{children:`An array of groups with all the pages within that group`}),_jsxs(Expandable,{title:`Navigation`,children:[_jsxs(ResponseField,{name:`group`,type:`string`,id:`param-group`,children:[_jsx(_components.p,{children:`The name of the group.`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`Settings`})]})]}),_jsxs(ResponseField,{name:`pages`,type:`string[]`,id:`param-pages`,children:[_jsx(_components.p,{children:`The relative paths to the markdown files that will serve as pages.`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`[\"customization\", \"page\"]`})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`logo`,type:`string or object`,id:`param-logo`,children:[_jsx(_components.p,{children:`Path to logo image or object with path to “light” and “dark” mode logo images`}),_jsxs(Expandable,{title:`Logo`,children:[_jsx(ResponseField,{name:`light`,type:`string`,id:`param-light`,children:_jsx(_components.p,{children:`Path to the logo in light mode`})}),_jsx(ResponseField,{name:`dark`,type:`string`,id:`param-dark`,children:_jsx(_components.p,{children:`Path to the logo in dark mode`})}),_jsx(ResponseField,{name:`href`,type:`string`,default:`/`,id:`param-href`,children:_jsx(_components.p,{children:`Where clicking on the logo links you to`})})]})]}),`\n`,_jsx(ResponseField,{name:`favicon`,type:`string`,id:`param-favicon`,children:_jsx(_components.p,{children:`Path to the favicon image`})}),`\n`,_jsxs(ResponseField,{name:`colors`,type:`Colors`,id:`param-colors`,children:[_jsx(_components.p,{children:`Hex color codes for your global theme`}),_jsxs(Expandable,{title:`Colors`,children:[_jsx(ResponseField,{name:`primary`,type:`string`,required:true,id:`param-primary`,children:_jsx(_components.p,{children:`The primary color. Used for most often for highlighted content, section\nheaders, accents, in light mode`})}),_jsx(ResponseField,{name:`light`,type:`string`,id:`param-light-1`,children:_jsx(_components.p,{children:`The primary color for dark mode. Used for most often for highlighted\ncontent, section headers, accents, in dark mode`})}),_jsx(ResponseField,{name:`dark`,type:`string`,id:`param-dark-1`,children:_jsx(_components.p,{children:`The primary color for important buttons`})}),_jsxs(ResponseField,{name:`background`,type:`object`,id:`param-background`,children:[_jsx(_components.p,{children:`The color of the background in both light and dark mode`}),_jsxs(Expandable,{title:`Object`,children:[_jsx(ResponseField,{name:`light`,type:`string`,required:true,id:`param-light-2`,children:_jsx(_components.p,{children:`The hex color code of the background in light mode`})}),_jsx(ResponseField,{name:`dark`,type:`string`,required:true,id:`param-dark-2`,children:_jsx(_components.p,{children:`The hex color code of the background in dark mode`})})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`topbarLinks`,type:`TopbarLink[]`,id:`param-topbar-links`,children:[_jsxs(_components.p,{children:[`Array of `,_jsx(_components.code,{children:`name`}),`s and `,_jsx(_components.code,{children:`url`}),`s of links you want to include in the topbar`]}),_jsxs(Expandable,{title:`TopbarLink`,children:[_jsxs(ResponseField,{name:`name`,type:`string`,id:`param-name-1`,children:[_jsx(_components.p,{children:`The name of the button.`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`Contact us`})]})]}),_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url`,children:_jsxs(_components.p,{children:[`The url once you click on the button. Example: `,_jsx(_components.code,{children:`https://mintlify.com/docs`})]})})]})]}),`\n`,_jsx(ResponseField,{name:`topbarCtaButton`,type:`Call to Action`,id:`param-topbar-cta-button`,children:_jsxs(Expandable,{title:`Topbar Call to Action`,children:[_jsx(ResponseField,{name:`type`,type:`\"link\" or \"github\"`,default:`link`,id:`param-type`,children:_jsx(_components.p,{children:`Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.`})}),_jsxs(ResponseField,{name:`url`,type:`string`,id:`param-url-1`,children:[_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`link`}),`: What the button links to.`]}),_jsxs(_components.p,{children:[`If `,_jsx(_components.code,{children:`github`}),`: Link to the repository to load GitHub information from.`]})]}),_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-2`,children:_jsxs(_components.p,{children:[`Text inside the button. Only required if `,_jsx(_components.code,{children:`type`}),` is a `,_jsx(_components.code,{children:`link`}),`.`]})})]})}),`\n`,_jsx(ResponseField,{name:`versions`,type:`string[]`,id:`param-versions`,children:_jsx(_components.p,{children:`Array of version names. Only use this if you want to show different versions\nof docs with a dropdown in the navigation bar.`})}),`\n`,_jsxs(ResponseField,{name:`anchors`,type:`Anchor[]`,id:`param-anchors`,children:[_jsxs(_components.p,{children:[`An array of the anchors, includes the `,_jsx(_components.code,{children:`icon`}),`, `,_jsx(_components.code,{children:`color`}),`, and `,_jsx(_components.code,{children:`url`}),`.`]}),_jsxs(Expandable,{title:`Anchor`,children:[_jsxs(ResponseField,{name:`icon`,type:`string`,id:`param-icon`,children:[_jsxs(_components.p,{children:[`The `,_jsx(_components.a,{href:`https://fontawesome.com/search?q=heart`,children:`Font Awesome`}),` icon used to feature the anchor.`]}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`comments`})]})]}),_jsxs(ResponseField,{name:`name`,type:`string`,id:`param-name-3`,children:[_jsx(_components.p,{children:`The name of the anchor label.`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`Community`})]})]}),_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url-2`,children:_jsx(_components.p,{children:`The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.`})}),_jsx(ResponseField,{name:`color`,type:`string`,id:`param-color`,children:_jsxs(_components.p,{children:[`The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `,_jsx(_components.code,{children:`from`}),` and `,_jsx(_components.code,{children:`to`}),` that are each a hex color.`]})}),_jsx(ResponseField,{name:`version`,type:`string`,id:`param-version`,children:_jsx(_components.p,{children:`Used if you want to hide an anchor until the correct docs version is selected.`})}),_jsx(ResponseField,{name:`isDefaultHidden`,type:`boolean`,default:`false`,id:`param-is-default-hidden`,children:_jsxs(_components.p,{children:[`Pass `,_jsx(_components.code,{children:`true`}),` if you want to hide the anchor until you directly link someone to docs inside it.`]})}),_jsx(ResponseField,{name:`iconType`,default:`duotone`,type:`string`,id:`param-icon-type`,children:_jsx(_components.p,{children:`One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”`})})]})]}),`\n`,_jsxs(ResponseField,{name:`topAnchor`,type:`Object`,id:`param-top-anchor`,children:[_jsx(_components.p,{children:`Override the default configurations for the top-most anchor.`}),_jsxs(Expandable,{title:`Object`,children:[_jsx(ResponseField,{name:`name`,default:`Documentation`,type:`string`,id:`param-name-4`,children:_jsx(_components.p,{children:`The name of the top-most anchor`})}),_jsx(ResponseField,{name:`icon`,default:`book-open`,type:`string`,id:`param-icon-1`,children:_jsx(_components.p,{children:`Font Awesome icon.`})}),_jsx(ResponseField,{name:`iconType`,default:`duotone`,type:`string`,id:`param-icon-type-1`,children:_jsx(_components.p,{children:`One of: “brands”, “duotone”, “light”, “sharp-solid”, “solid”, or “thin”`})})]})]}),`\n`,_jsxs(ResponseField,{name:`tabs`,type:`Tabs[]`,id:`param-tabs`,children:[_jsx(_components.p,{children:`An array of navigational tabs.`}),_jsxs(Expandable,{title:`Tabs`,children:[_jsx(ResponseField,{name:`name`,type:`string`,id:`param-name-5`,children:_jsx(_components.p,{children:`The name of the tab label.`})}),_jsx(ResponseField,{name:`url`,type:`string`,id:`param-url-3`,children:_jsx(_components.p,{children:`The start of the URL that marks what pages go in the tab. Generally, this\nis the name of the folder you put your pages in.`})})]})]}),`\n`,_jsxs(ResponseField,{name:`api`,type:`API`,id:`param-api`,children:[_jsxs(_components.p,{children:[`Configuration for API settings. Learn more about API pages at `,_jsx(_components.a,{href:`/api-playground/demo`,children:`API Components`}),`.`]}),_jsxs(Expandable,{title:`API`,children:[_jsx(ResponseField,{name:`baseUrl`,type:`string`,id:`param-base-url`,children:_jsxs(_components.p,{children:[`The base url for all API endpoints. If `,_jsx(_components.code,{children:`baseUrl`}),` is an array, it will enable for multiple base url\noptions that the user can toggle.`]})}),_jsx(ResponseField,{name:`auth`,type:`Auth`,id:`param-auth`,children:_jsxs(Expandable,{title:`Auth`,children:[_jsx(ResponseField,{name:`method`,type:`\"bearer\" | \"basic\" | \"key\"`,id:`param-method`,children:_jsx(_components.p,{children:`The authentication strategy used for all API endpoints.`})}),_jsxs(ResponseField,{name:`name`,type:`string`,id:`param-name-6`,children:[_jsx(_components.p,{children:`The name of the authentication parameter used in the API playground.`}),_jsxs(_components.p,{children:[`If method is `,_jsx(_components.code,{children:`basic`}),`, the format should be `,_jsx(_components.code,{children:`[usernameName]:[passwordName]`})]})]}),_jsxs(ResponseField,{name:`inputPrefix`,type:`string`,id:`param-input-prefix`,children:[_jsx(_components.p,{children:`The default value that’s designed to be a prefix for the authentication input field.`}),_jsxs(_components.p,{children:[`E.g. If an `,_jsx(_components.code,{children:`inputPrefix`}),` of `,_jsx(_components.code,{children:`AuthKey`}),` would inherit the default input result of the authentication field as `,_jsx(_components.code,{children:`AuthKey`}),`.`]})]})]})}),_jsxs(ResponseField,{name:`playground`,type:`Playground`,id:`param-playground`,children:[_jsx(_components.p,{children:`Configurations for the API playground`}),_jsx(Expandable,{title:`Playground`,children:_jsxs(ResponseField,{name:`mode`,default:`show`,type:`\"show\" | \"simple\" | \"hide\"`,id:`param-mode`,children:[_jsxs(_components.p,{children:[`Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `,_jsx(_components.code,{children:`simple`})]}),_jsxs(_components.p,{children:[`Learn more at the `,_jsx(_components.a,{href:`/api-playground/demo`,children:`playground guides`})]})]})})]}),_jsxs(ResponseField,{name:`maintainOrder`,type:`boolean`,id:`param-maintain-order`,children:[_jsx(_components.p,{children:`Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.`}),_jsx(Warning,{children:`This behavior will soon be enabled by default, at which point this field will be deprecated.`})]})]})]}),`\n`,_jsxs(ResponseField,{name:`openapi`,type:`string | string[]`,id:`param-openapi`,children:[_jsx(_components.p,{children:`A string or an array of strings of URL(s) or relative path(s) pointing to your\nOpenAPI file.`}),_jsx(_components.p,{children:`Examples:`}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Absolute`,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"openapi\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/openapi.json\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Relative`,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"openapi\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"/openapi.json\"`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Multiple`,numberOfLines:`1`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"openapi\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/openapi1.json\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"/openapi2.json\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"/openapi3.json\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`]})})})]})]}),`\n`,_jsxs(ResponseField,{name:`footerSocials`,type:`FooterSocials`,id:`param-footer-socials`,children:[_jsx(_components.p,{children:`An object of social media accounts where the key:property pair represents the social media platform and the account url.`}),_jsx(_components.p,{children:`Example:`}),_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"x\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"https://x.com/mintlify\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"website\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"https://mintlify.com\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(Expandable,{title:`FooterSocials`,children:[_jsxs(ResponseField,{name:`[key]`,type:`string`,id:`param-key`,children:[_jsxs(_components.p,{children:[`One of the following values `,_jsx(_components.code,{children:`website`}),`, `,_jsx(_components.code,{children:`facebook`}),`, `,_jsx(_components.code,{children:`x`}),`, `,_jsx(_components.code,{children:`discord`}),`, `,_jsx(_components.code,{children:`slack`}),`, `,_jsx(_components.code,{children:`github`}),`, `,_jsx(_components.code,{children:`linkedin`}),`, `,_jsx(_components.code,{children:`instagram`}),`, `,_jsx(_components.code,{children:`hacker-news`})]}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`x`})]})]}),_jsxs(ResponseField,{name:`property`,type:`string`,id:`param-property`,children:[_jsx(_components.p,{children:`The URL to the social platform.`}),_jsxs(_components.p,{children:[`Example: `,_jsx(_components.code,{children:`https://x.com/mintlify`})]})]})]})]}),`\n`,_jsxs(ResponseField,{name:`feedback`,type:`Feedback`,id:`param-feedback`,children:[_jsx(_components.p,{children:`Configurations to enable feedback buttons`}),_jsxs(Expandable,{title:`Feedback`,children:[_jsx(ResponseField,{name:`suggestEdit`,type:`boolean`,default:`false`,id:`param-suggest-edit`,children:_jsx(_components.p,{children:`Enables a button to allow users to suggest edits via pull requests`})}),_jsx(ResponseField,{name:`raiseIssue`,type:`boolean`,default:`false`,id:`param-raise-issue`,children:_jsx(_components.p,{children:`Enables a button to allow users to raise an issue about the documentation`})})]})]}),`\n`,_jsxs(ResponseField,{name:`modeToggle`,type:`ModeToggle`,id:`param-mode-toggle`,children:[_jsx(_components.p,{children:`Customize the dark mode toggle.`}),_jsxs(Expandable,{title:`ModeToggle`,children:[_jsx(ResponseField,{name:`default`,type:`\"light\" or \"dark\"`,id:`param-default`,children:_jsx(_components.p,{children:`Set if you always want to show light or dark mode for new users. When not\nset, we default to the same mode as the user’s operating system.`})}),_jsxs(ResponseField,{name:`isHidden`,type:`boolean`,default:`false`,id:`param-is-hidden`,children:[_jsxs(_components.p,{children:[`Set to true to hide the dark/light mode toggle. You can combine `,_jsx(_components.code,{children:`isHidden`}),` with `,_jsx(_components.code,{children:`default`}),` to force your docs to only use light or dark mode. For example:`]}),_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Only Dark Mode`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"modeToggle\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"default\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"dark\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"isHidden\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Only Light Mode`,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes dark-plus dark-plus`,style:{backgroundColor:`#0B0C0E`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"modeToggle\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"default\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#CE9178`,\"--shiki-dark\":`#CE9178`},children:`\"light\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#9CDCFE`,\"--shiki-dark\":`#9CDCFE`},children:` \"isHidden\"`}),_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#569CD6`,\"--shiki-dark\":`#569CD6`},children:`true`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#D4D4D4`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})]})]}),`\n`,_jsx(ResponseField,{name:`backgroundImage`,type:`string`,id:`param-background-image`,children:_jsxs(_components.p,{children:[`A background image to be displayed behind every page. See example with\n`,_jsx(_components.a,{href:`https://infisical.com/docs`,children:`Infisical`}),` and `,_jsx(_components.a,{href:`https://frpc.io`,children:`FRPC`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Global Settings","description":"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file","icon":"gear","href":"/essentials/settings","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Properties","slug":"properties","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"frenflow","siteName":"FrenFlow","title":"Global Settings - FrenFlow","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-13T20:37:08.373Z","originalFileLocation":"essentials/settings.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file\">\u003cmeta data-mint-head name=\"application-name\" content=\"FrenFlow\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Global Settings - FrenFlow\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to trade prediction markets, copy top traders, and earn rewards on FrenFlow.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FrenFlow Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frenflow.com/essentials/settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://frenflow.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Global+Settings\u0026amp;description=Mintlify+gives+you+complete+control+over+the+look+and+feel+of+your+documentation+using+the+docs.json+file\u0026amp;theme=14c2f9cd9a7bad3b8a7c60d9\u0026amp;signature=51ece7d6677488ddedc170a38d7aff0977d8a13758d1136fad3bc7616e9f10a3\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Global Settings - FrenFlow\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to trade prediction markets, copy top traders, and earn rewards on FrenFlow.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://frenflow.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Global+Settings\u0026amp;description=Mintlify+gives+you+complete+control+over+the+look+and+feel+of+your+documentation+using+the+docs.json+file\u0026amp;theme=14c2f9cd9a7bad3b8a7c60d9\u0026amp;signature=51ece7d6677488ddedc170a38d7aff0977d8a13758d1136fad3bc7616e9f10a3\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/frenflow/iEBi1mXRsfQiGXXu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FrenFlow\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#baf820\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@frenflow\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.frenflow.com/essentials/settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/essentials/settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.frenflow.com/#organization\",\"name\":\"FrenFlow\",\"url\":\"https://docs.frenflow.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/frenflow/P3ppkZGEivxpUD4h/images/frenflow_logo.png?fit=max\u0026auto=format\u0026n=P3ppkZGEivxpUD4h\u0026q=85\u0026s=50538051f7e174e88700f0981d1ef567\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.frenflow.com#website\",\"name\":\"FrenFlow\",\"url\":\"https://docs.frenflow.com\",\"publisher\":{\"@id\":\"https://docs.frenflow.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.frenflow.com/essentials/settings#webpage\",\"url\":\"https://docs.frenflow.com/essentials/settings\",\"name\":\"Global Settings\",\"description\":\"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file\",\"dateModified\":\"2026-03-13T20:37:08.373Z\",\"isPartOf\":{\"@id\":\"https://docs.frenflow.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.frenflow.com/essentials/settings#article\",\"headline\":\"Global Settings\",\"name\":\"Global Settings\",\"description\":\"Mintlify gives you complete control over the look and feel of your documentation using the docs.json file\",\"url\":\"https://docs.frenflow.com/essentials/settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frenflow.com/essentials/settings#webpage\"},\"dateModified\":\"2026-03-13T20:37:08.373Z\",\"publisher\":{\"@id\":\"https://docs.frenflow.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.frenflow.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FrenFlow\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FrenFlow\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/essentials/settings.md","siteName":"FrenFlow","nav":{"global":{"anchors":[]},"groups":[{"group":"FrenFlow Docs","pages":[{"title":"FrenFlow — Prediction Markets, Together","sidebarTitle":"Introduction","icon":"house","href":"/index"},{"title":"Frequently Asked Questions","sidebarTitle":"FAQ","icon":"book-open","href":"/faq"}]},{"group":"Markets","pages":[{"title":"Prediction Markets on FrenFlow","sidebarTitle":"Markets","icon":"globe","href":"/markets/overview"},{"title":"Polymarket on FrenFlow","sidebarTitle":"Polymarket","icon":"circle-dot","href":"/markets/polymarket"},{"title":"Kalshi on FrenFlow","sidebarTitle":"Kalshi","icon":"shield-check","href":"/markets/kalshi"},{"title":"Predict.fun on FrenFlow","sidebarTitle":"Predict.fun","icon":"chart-scatter","href":"/markets/predict"},{"title":"Market Categories","sidebarTitle":"Categories","icon":"layout-grid","href":"/markets/categories"},{"title":"Search Markets","sidebarTitle":"Search","icon":"search","href":"/markets/search"}]},{"group":"Sports \u0026 Live","pages":[{"title":"Sports \u0026 Live","sidebarTitle":"Overview","icon":"trophy","href":"/sports/overview"}]},{"group":"Trading","pages":[{"title":"How Trading Works on FrenFlow","sidebarTitle":"Trading","icon":"chart-bar","href":"/trading/markets"},{"title":"Placing Trades on FrenFlow","sidebarTitle":"Placing Trades","icon":"arrow-right-left","href":"/trading/placing-trades"},{"title":"Selling Positions","sidebarTitle":"Selling","icon":"arrow-down-to-line","href":"/trading/selling"},{"title":"Redeeming Resolved Positions","sidebarTitle":"Redeem","icon":"circle-check","href":"/trading/redeem"},{"title":"Order Types — Market \u0026 Limit Orders","sidebarTitle":"Order Types","icon":"list-ordered","href":"/trading/order-types"},{"title":"Trading Fees on FrenFlow","sidebarTitle":"Fees","icon":"receipt","href":"/trading/fees"}]},{"group":"Copy Trading","pages":[{"title":"Copy Trading on FrenFlow","sidebarTitle":"How It Works","icon":"info","href":"/copy-trading/how-it-works"},{"title":"Follow a Leader — Copy Trading","sidebarTitle":"Follow a Leader","icon":"user-check","href":"/copy-trading/follow-a-leader"},{"title":"Copy Trading Settings","sidebarTitle":"Settings","icon":"settings","href":"/copy-trading/settings"},{"title":"Zero-Block Execution","sidebarTitle":"Zero-Block","icon":"zap","href":"/copy-trading/zero-block"},{"title":"Copy Trading Risks","sidebarTitle":"Risks","icon":"triangle-alert","href":"/copy-trading/risks"}]},{"group":"Leaderboard","pages":[{"title":"Prediction Market Trader Leaderboard","sidebarTitle":"Leaderboard","icon":"trophy","href":"/leaderboard/overview"},{"title":"Trader Profiles — Stats \u0026 History","sidebarTitle":"Trader Profiles","icon":"user","href":"/leaderboard/profiles"},{"title":"Leaderboard Filters","sidebarTitle":"Filters","icon":"list-filter","href":"/leaderboard/filters"}]},{"group":"Portfolio","pages":[{"title":"Portfolio Positions","sidebarTitle":"Positions","icon":"target","href":"/portfolio/positions"},{"title":"Trade History","sidebarTitle":"History","icon":"clock","href":"/portfolio/history"},{"title":"Profit \u0026 Loss Tracking","sidebarTitle":"P\u0026L","icon":"trending-up","href":"/portfolio/pnl"}]},{"group":"Degenbox","pages":[{"title":"Degenbox — Custom Dashboard","sidebarTitle":"Degenbox","icon":"layout-dashboard","href":"/degenbox/overview"},{"title":"Customize Your Degenbox","sidebarTitle":"Customize","icon":"sliders-horizontal","href":"/degenbox/customize"}]},{"group":"BubbleFlow","pages":[{"title":"BubbleFlow","sidebarTitle":"Overview","icon":"circle","href":"/bubbleflow/overview"}]},{"group":"Social","pages":[{"title":"Social Feed","sidebarTitle":"Feed","icon":"rss","href":"/social/feed"},{"title":"Social Posts","sidebarTitle":"Posts","icon":"pen-line","href":"/social/posts"},{"title":"Comments \u0026 Discussion","sidebarTitle":"Comments","icon":"message-circle","href":"/social/comments"},{"title":"Follow Traders","sidebarTitle":"Following","icon":"users","href":"/social/following"}]},{"group":"Wallet","pages":[{"title":"Deposit Funds","sidebarTitle":"Deposit","icon":"download","href":"/wallet/deposit"},{"title":"Withdraw Funds","sidebarTitle":"Withdraw","icon":"upload","href":"/wallet/withdraw"},{"title":"Wallet Balances","sidebarTitle":"Balances","icon":"coins","href":"/wallet/balances"},{"title":"Cross-Chain Bridging","sidebarTitle":"Bridging","icon":"shuffle","href":"/wallet/bridging"}]},{"group":"FrenLinks","pages":[{"title":"FrenLinks","sidebarTitle":"Overview","icon":"link","href":"/frenlinks/overview"}]},{"group":"Wallet Tracker","pages":[{"title":"Wallet Tracker","icon":"radar","href":"/wallet-tracker/overview"},{"title":"Add Wallet to Tracker","sidebarTitle":"Add Wallet","icon":"plus","href":"/wallet-tracker/add-wallet"},{"title":"Wallet Trade Alerts","sidebarTitle":"Alerts","icon":"bell-ring","href":"/wallet-tracker/alerts"}]},{"group":"Alerts","pages":[{"title":"Price Alerts","sidebarTitle":"Price Alerts","icon":"bell-ring","href":"/alerts/price-alerts"},{"title":"Notification Settings","sidebarTitle":"Notifications","icon":"bell","href":"/alerts/notifications"}]},{"group":"Fren Points","pages":[{"title":"How to Earn Fren Points","sidebarTitle":"How to Earn","icon":"trophy","href":"/fren-points/how-to-earn"},{"title":"Fren Points Levels \u0026 Tiers","sidebarTitle":"Levels","icon":"arrow-up-right","href":"/fren-points/levels"},{"title":"Fren Points Rewards","sidebarTitle":"Chests \u0026 Rewards","icon":"gift","href":"/fren-points/rewards"}]},{"group":"Referrals","pages":[{"title":"Invite Friends — Referral Program","sidebarTitle":"Invite Friends","icon":"user-plus","href":"/referrals/invite-friends"},{"title":"Daily Spin — Free Rewards","sidebarTitle":"Daily Spin","icon":"loader","href":"/referrals/daily-spin"},{"title":"Referral Rewards \u0026 Bonuses","sidebarTitle":"Earnings","icon":"star","href":"/referrals/rewards"}]},{"group":"Affiliate","pages":[{"title":"FrenFlow Affiliate Program","sidebarTitle":"Affiliate","icon":"handshake","href":"/affiliate/overview"},{"title":"Affiliate Marketing Toolkit","sidebarTitle":"Toolkit","icon":"wrench","href":"/affiliate/toolkit"},{"title":"Affiliate Commission Structure","sidebarTitle":"Commissions","icon":"dollar-sign","href":"/affiliate/commissions"}]},{"group":"Arbitrage","pages":[{"title":"Arbitrage","sidebarTitle":"Overview","icon":"scale-balanced","href":"/arbitrage/overview"}]},{"group":"UMA","pages":[{"title":"UMA Oracle on FrenFlow","sidebarTitle":"UMA","icon":"scale","href":"/uma/overview"},{"title":"UMA Voting — Resolve Disputes","sidebarTitle":"Voting","icon":"vote","href":"/uma/voting"},{"title":"UMA Voting Analytics","sidebarTitle":"Analytics","icon":"chart-column","href":"/uma/analytics"}]},{"group":"Settings","pages":[{"title":"Profile Settings","sidebarTitle":"Profile","icon":"user","href":"/settings/profile"},{"title":"Trading Settings","sidebarTitle":"Trading","icon":"settings-2","href":"/settings/trading"},{"title":"Quick Buy Settings","sidebarTitle":"Quick Buy","icon":"zap","href":"/settings/quick-buy"}]},{"group":"Integrations","pages":[{"title":"Integrations — Coming Soon","sidebarTitle":"Coming Soon","icon":"rocket","href":"/integrations/coming-soon"},{"title":"FrenFlow on DexTools","sidebarTitle":"DexTools","icon":"puzzle","hidden":true,"href":"/integrations/dextools"}]},{"group":"Telegram Bot","pages":[{"title":"FrenFlow Telegram Bot Setup","sidebarTitle":"Setup","icon":"play","href":"/telegram-bot/setup"},{"title":"Telegram Bot Commands","sidebarTitle":"Commands","icon":"terminal","href":"/telegram-bot/commands"},{"title":"Telegram Notifications","sidebarTitle":"Notifications","icon":"bell","href":"/telegram-bot/notifications"}]},{"group":"Guides — Web","pages":[{"title":"Getting Started with FrenFlow","sidebarTitle":"Getting Started","icon":"rocket","href":"/guides/getting-started"},{"title":"Your First Prediction Market Trade","sidebarTitle":"First Trade","icon":"circle-play","href":"/guides/first-trade"},{"title":"How to Sell \u0026 Redeem Positions","sidebarTitle":"Sell \u0026 Redeem","icon":"circle-dollar-sign","href":"/guides/sell-and-redeem"},{"title":"Fund Your Wallet — Complete Guide","sidebarTitle":"Fund Your Wallet","icon":"wallet","href":"/guides/funding-your-wallet"},{"title":"Copy Your First Trader","icon":"users","href":"/guides/first-copy-trade"},{"title":"Set Up Wallet Tracker","icon":"radar","href":"/guides/wallet-tracker-setup"},{"title":"How to Use Degenbox","icon":"layout-dashboard","href":"/guides/degenbox-setup"},{"title":"Set Up Price Alerts","icon":"bell-ring","href":"/guides/price-alerts-setup"},{"title":"Share Your PnL","icon":"share-2","href":"/guides/share-your-pnl"},{"title":"Maximize Referral Earnings","sidebarTitle":"Maximize Referrals","icon":"user-plus","href":"/guides/maximize-referrals"}]},{"group":"Guides — Telegram","pages":[{"title":"Trading from Telegram","icon":"send","href":"/guides/trading-from-telegram"},{"title":"Copy Trading on Telegram","icon":"copy","href":"/guides/copy-trading-telegram"},{"title":"Manage Wallet from Telegram","icon":"wallet","href":"/guides/telegram-wallet"},{"title":"Alerts \u0026 Notifications on Telegram","icon":"bell","href":"/guides/telegram-alerts"}]},{"group":"Guides — Cross-Platform","pages":[{"title":"Link Web + Telegram Accounts","sidebarTitle":"Link Web + Telegram","icon":"link","href":"/guides/link-web-telegram"},{"title":"Earn Fren Points — Complete Guide","sidebarTitle":"Earn Fren Points","icon":"trophy","href":"/guides/earning-fren-points"}]}]},"basePath":"","title":"Global Settings - FrenFlow","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["10e4515597"],"chunks":["BannerMarkdown-BjdIPj1P.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}