CINXE.COM

<!DOCTYPE html><html lang="en" class="dark"><head><meta charSet="utf-8"/><meta name="viewport" content="width=device-width"/><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/apple-touch-icon.png?v=3"/><link rel="icon" type="image/png" sizes="32x32" href="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/favicon-32x32.png?v=3"/><link rel="icon" type="image/png" sizes="16x16" href="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/favicon-16x16.png?v=3"/><link rel="shortcut icon" type="image/x-icon" href="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/favicon.ico?v=3"/><meta name="msapplication-config" content="https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/browserconfig.xml?v=3"/><meta name="apple-mobile-web-app-title" content="Mintlify"/><meta name="application-name" content="Mintlify"/><meta name="msapplication-TileColor" content="#0D9373"/><meta name="theme-color" content="#ffffff"/><link rel="sitemap" type="application/xml" href="/docs/sitemap.xml"/><meta name="charset" content="utf-8"/><meta name="og:type" content="website"/><meta name="og:site_name" content="Mintlify"/><meta name="twitter:card" content="summary_large_image"/><meta name="og:title" content="Quickstart - Mintlify"/><meta name="twitter:title" content="Quickstart - Mintlify"/><meta name="og:description" content="Start building modern documentation in under five minutes"/><meta name="description" content="Start building modern documentation in under five minutes"/><meta name="image" property="og:image" content="https://mintlify.com/docs/api/og?division=Documentation&title=Quickstart&description=Start+building+modern+documentation+in+under+five+minutes&logoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fmintlify%2Flogo%2Flight.svg&logoDark=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fmintlify%2Flogo%2Fdark.svg&primaryColor=%230D9373&lightColor=%2355D799&darkColor=%230D9373"/><meta property="og:image:width" content="1200"/><meta property="og:image:height" content="630"/><meta name="twitter:image" property="twitter:image" content="https://mintlify.com/docs/api/og?division=Documentation&title=Quickstart&description=Start+building+modern+documentation+in+under+five+minutes&logoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fmintlify%2Flogo%2Flight.svg&logoDark=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fmintlify%2Flogo%2Fdark.svg&primaryColor=%230D9373&lightColor=%2355D799&darkColor=%230D9373"/><meta name="twitter:card" property="twitter:card" content="summary_large_image"/><meta property="twitter:image:width" content="1200"/><meta property="twitter:image:height" content="630"/><title>Quickstart - Mintlify</title><meta name="og:url" content="/docs/quickstart"/><link rel="canonical" href="/docs/quickstart"/><meta name="next-head-count" content="30"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.0/dist/katex.min.css" integrity="sha384-Xi8rHCmBmhbuyyhbI88391ZKP2dmfnOl4rT9ZfRI7mLTdk1wblIUnrIq35nqwEvC" crossorigin="anonymous"/><link rel="preload" href="/docs/_next/static/media/a34f9d1faa5f3315-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/docs/_next/static/media/bb3ef058b751a6ad-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><script id="mode-toggle" data-nscript="beforeInteractive"> try { if (localStorage.isDarkMode === 'true') { document.documentElement.classList.add('dark'); } else if (localStorage.isDarkMode === 'false') { document.documentElement.classList.remove('dark'); } else if ((true && !('isDarkMode' in localStorage) && window.matchMedia('(prefers-color-scheme: dark)').matches) || false) { document.documentElement.classList.add('dark'); } else { document.documentElement.classList.remove('dark'); } } catch (_) {}</script><link rel="preload" href="/docs/_next/static/css/0cfc819f85033935.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/0cfc819f85033935.css" data-n-g=""/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="/docs/_next/static/chunks/polyfills-42372ed130431b0a.js"></script><script src="/docs/_next/static/chunks/webpack-2930143a581b7923.js" defer=""></script><script src="/docs/_next/static/chunks/framework-9ae01a5f4ade81f5.js" defer=""></script><script src="/docs/_next/static/chunks/main-8a1046ec06751e09.js" defer=""></script><script src="/docs/_next/static/chunks/pages/_app-5fc343aaafb55d2a.js" defer=""></script><script src="/docs/_next/static/chunks/2edb282b-a83f7ffd007bccf0.js" defer=""></script><script src="/docs/_next/static/chunks/e893f787-f6a1094a35763a0d.js" defer=""></script><script src="/docs/_next/static/chunks/086d643d-6f7196a364073d16.js" defer=""></script><script src="/docs/_next/static/chunks/9097-597bce25a41f76db.js" defer=""></script><script src="/docs/_next/static/chunks/7669-b7b6e74eb838f0fc.js" defer=""></script><script src="/docs/_next/static/chunks/7610-e463a3dc6ba2cbb8.js" defer=""></script><script src="/docs/_next/static/chunks/40-73655ea3c5690e93.js" defer=""></script><script src="/docs/_next/static/chunks/pages/_sites/%5Bsubdomain%5D/%5B%5B...slug%5D%5D-79e8424968849281.js" defer=""></script><script src="/docs/_next/static/s_rCgYEQNhgGM0glymDTI/_buildManifest.js" defer=""></script><script src="/docs/_next/static/s_rCgYEQNhgGM0glymDTI/_ssgManifest.js" defer=""></script><style id="__jsx-3178852779">:root{--font-inter:'__Inter_c8d9fa', '__Inter_Fallback_c8d9fa';--font-jetbrains-mono:'__JetBrains_Mono_ea4744', '__JetBrains_Mono_Fallback_ea4744'}</style></head><div id="__next"><main class="jsx-3178852779"><style>:root { --primary: 13 147 115; --primary-light: 85 215 153; --primary-dark: 13 147 115; --background-light: 255 255 255; --background-dark: 11 13 14; --gray-50: 243 247 246; --gray-100: 238 242 241; --gray-200: 222 226 226; --gray-300: 206 210 209; --gray-400: 158 163 162; --gray-500: 112 116 115; --gray-600: 80 84 83; --gray-700: 62 67 66; --gray-800: 37 41 40; --gray-900: 23 27 26; --gray-950: 10 14 13; }</style><span class="fixed inset-0 bg-background-light dark:bg-background-dark -z-10"></span><div class="relative antialiased text-gray-500 dark:text-gray-400"><div class="flex"><div class="hidden lg:flex fixed flex-col left-0 top-0 bottom-0 w-[19rem] border-r border-gray-200/70 dark:border-white/[0.07]" id="sidebar"><div class="flex-1 overflow-y-auto px-7 py-6" id="sidebar-content"><div class="flex justify-between items-center"><img class="w-auto relative object-contain block dark:hidden px-1 h-6" src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/light.svg" alt="light logo"/><img class="w-auto relative object-contain hidden dark:block px-1 h-6" src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/dark.svg" alt="dark logo"/><button class="relative flex h-7 w-[3.25rem] items-center rounded-full border border-gray-200/70 dark:border-white/[0.07] hover:border-gray-200 dark:hover:border-white/10 p-1" aria-label="Toggle dark mode"><div class="z-10 flex w-full items-center justify-between px-1"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" xmlns="http://www.w3.org/2000/svg" class="size-3 text-gray-600 dark:text-gray-600 fill-current"><g clip-path="url(#clip0_2880_7340)"><path d="M8 1.11133V2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 3.12891L12.2427 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M14.8889 8H14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 12.8711L12.2427 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8 14.8889V14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 12.8711L3.75735 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M1.11133 8H2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 3.12891L3.75735 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8.00043 11.7782C10.0868 11.7782 11.7782 10.0868 11.7782 8.00043C11.7782 5.91402 10.0868 4.22266 8.00043 4.22266C5.91402 4.22266 4.22266 5.91402 4.22266 8.00043C4.22266 10.0868 5.91402 11.7782 8.00043 11.7782Z" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></g><defs><clipPath id="clip0_2880_7340"><rect width="16" height="16" fill="white"></rect></clipPath></defs></svg><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" xmlns="http://www.w3.org/2000/svg" class="size-3 text-gray-300 dark:text-gray-300 fill-current"><g clip-path="url(#clip0_2880_7355)"><path d="M11.5556 10.4445C8.48717 10.4445 6.00005 7.95743 6.00005 4.88899C6.00005 3.68721 6.38494 2.57877 7.03294 1.66943C4.04272 2.22766 1.77783 4.84721 1.77783 8.0001C1.77783 11.5592 4.66317 14.4445 8.22228 14.4445C11.2196 14.4445 13.7316 12.3948 14.4525 9.62321C13.6081 10.1414 12.6187 10.4445 11.5556 10.4445Z" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></g><defs><clipPath id="clip0_2880_7355"><rect width="16" height="16" fill="white"></rect></clipPath></defs></svg></div><div class="absolute left-1 h-5 w-5 rounded-full bg-gray-100 dark:bg-white/[0.07] transition-transform duration-200 dark:translate-x-[1.40rem]"></div></button></div><button type="button" class="hidden lg:flex relative flex-1 pointer-events-auto rounded-xl w-full items-center text-sm leading-6 py-1.5 pl-3.5 pr-3 text-gray-400 dark:text-white/50 dark:brightness-[1.1] dark:ring-1 dark:hover:brightness-[1.25] ring-1 ring-gray-400/20 hover:ring-gray-600/25 dark:ring-gray-600/30 dark:hover:ring-gray-500/30 focus:outline-primary justify-between truncate gap-2 min-w-[43px] mt-6 bg-gray-50/50 dark:bg-white/5" id="search-bar-entry"><div class="flex items-center gap-3 min-w-[42px]"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-search min-w-4 flex-none text-gray-700 hover:text-gray-800 dark:text-gray-300 hover:dark:text-gray-200"><circle cx="11" cy="11" r="8"></circle><path d="m21 21-4.3-4.3"></path></svg><div class="truncate min-w-0">Search or ask...</div></div></button><button type="button" id="radix-:R1lcql6:" aria-haspopup="menu" aria-expanded="false" data-state="closed" class="group bg-background-light dark:bg-background-dark disabled:pointer-events-none [&>span]:line-clamp-1 overflow-hidden group outline-none text-sm text-gray-950/50 dark:text-white/50 group-hover:text-gray-950/70 dark:group-hover:text-white/70 z-10 group flex w-full items-center pl-2 pr-3.5 py-1.5 rounded-[0.85rem] border border-gray-200/70 dark:border-white/[0.07] hover:bg-gray-600/5 dark:hover:bg-gray-200/5 mb-4 gap-1 mt-4"><div class="h-8 w-8 flex items-center justify-center rounded-lg flex-shrink-0 border border-gray-200/70 dark:border-white/[0.07]"><svg class="h-4 w-4 bg-primary dark:bg-primary-light" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/book.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/book.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="flex-1 px-1 flex flex-col grow text-left"><p class="text-base lg:text-sm text-gray-900 dark:text-gray-200 font-medium">Getting Started</p><p class="hidden lg:block text-sm lg:text-xs text-gray-600 dark:text-gray-400" title="Set up your documentation">Set up your documentation</p></div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 rotate-90"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></button><div class="-mx-3 text-sm" id="navigation-items"><div class="mt-8"></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 text-gray-900 dark:text-gray-200 font-medium">Getting Started</h5><ul><li id="/quickstart" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-primary dark:border-primary-light text-primary font-semibold dark:text-primary-light" style="padding-left:1rem" href="/docs/quickstart"><svg class="h-4 w-4 bg-primary dark:bg-primary-light" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/rocket.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/rocket.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Quickstart</div></div></a></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/pen-paintbrush.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/pen-paintbrush.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">Editing</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/settings/global" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/global"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/wrench.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/wrench.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Global Settings</div></div></a></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/map.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/map.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">Navigation</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/migration" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/migration"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/arrow-up-from-bracket.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/arrow-up-from-bracket.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Migration</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 text-gray-900 dark:text-gray-200 font-medium">Writing Content</h5><ul><li id="/page" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/page"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/text-size.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/text-size.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Page Titles and Metadata</div></div></a></li><li id="/text" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/text"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/heading.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/heading.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Headers and Text</div></div></a></li><li id="/image-embeds" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/image-embeds"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/image.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/image.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Images, Videos, and Embeds</div></div></a></li><li id="/list-table" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/list-table"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/list.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/list.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Lists and Tables</div></div></a></li><li id="/code" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/code"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Code Blocks</div></div></a></li><li id="/reusable-snippets" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/reusable-snippets"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/recycle.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/recycle.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Reusable Snippets</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 text-gray-900 dark:text-gray-200 font-medium">API References</h5><ul><li id="/api-playground/overview" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/api-playground/overview"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/play.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/play.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Playground</div></div></a></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/brackets-curly.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/brackets-curly.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">OpenAPI</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/markdown.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/markdown.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">MDX</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li id="/api-playground/troubleshooting" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/api-playground/troubleshooting"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/triangle-exclamation.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/triangle-exclamation.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Troubleshooting</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 text-gray-900 dark:text-gray-200 font-medium">Configurations</h5><ul><li id="/settings/custom-domain" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/custom-domain"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/globe.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/globe.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Custom Domain</div></div></a></li><li id="/settings/seo" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/seo"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/magnifying-glass.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/magnifying-glass.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>SEO</div></div></a></li><li id="/settings/custom-scripts" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/custom-scripts"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Custom CSS & JS</div></div></a></li><li id="/settings/broken-links" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/broken-links"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/link-simple.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/link-simple.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Redirects and Broken Links</div></div></a></li><li id="/settings/github" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/github"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>GitHub</div></div></a></li><li id="/settings/gitlab" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/gitlab"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/gitlab.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/gitlab.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>GitLab</div></div></a></li><li id="/settings/ci" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/ci"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/circle-check.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/circle-check.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>CI Checks</div></div></a></li><li id="/settings/preview-deployments" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="/docs/settings/preview-deployments"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/street-view.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/street-view.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1 flex items-center space-x-2.5"><div>Preview Deployments</div></div></a></li></ul></div><div class="mt-12 lg:mt-8"><h5 class="pl-4 mb-3.5 lg:mb-2.5 text-gray-900 dark:text-gray-200 font-medium">Advanced</h5><ul><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/folder.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/folder.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">Custom Subdirectory</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/user-lock.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/user-lock.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">Auth & Personalization</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/house-lock.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/house-lock.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">Dashboard Access</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li><li><div class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 lg:ml-4 border-l border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem"><svg class="h-4 w-4 bg-gray-400 dark:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/brackets-curly.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/brackets-curly.svg);mask-repeat:no-repeat;mask-position:center"></svg><div class="flex-1">REST API</div><svg width="8" height="24" viewBox="0 -9 3 24" class="transition-transform text-gray-400 overflow-visible group-hover:text-gray-600 dark:text-gray-600 dark:group-hover:text-gray-400 -mr-0.5"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></li></ul></div></div></div><ul class="px-4 py-3 w-[calc(19rem-1px)] left-0 right-0 bottom-0 bg-background-light dark:bg-background-dark border-t border-gray-200/70 dark:border-white/[0.07] text-sm"><li id="https://mintlify.com/community" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="https://mintlify.com/community"><div class="flex-1 flex items-center space-x-2.5"><div>Community</div></div><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-up-right size-3.5 text-gray-400 dark:text-gray-500 group-hover:text-gray-500 dark:group-hover:text-gray-400"><path d="M7 7h10v10"></path><path d="M7 17 17 7"></path></svg></a></li><li id="https://mintlify.com/start" class="scroll-m-4 first:scroll-m-20"><a class="group mt-2 lg:mt-0 flex items-center pr-3 py-1.5 cursor-pointer focus:outline-primary dark:focus:outline-primary-light gap-x-3 border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 text-gray-700 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" style="padding-left:1rem" href="https://mintlify.com/start"><div class="flex-1 flex items-center space-x-2.5"><div>Get Started</div></div><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-arrow-up-right size-3.5 text-gray-400 dark:text-gray-500 group-hover:text-gray-500 dark:group-hover:text-gray-400"><path d="M7 7h10v10"></path><path d="M7 17 17 7"></path></svg></a></li><div class="flex items-center gap-x-2"></div></ul></div><div class="block lg:hidden"><div id="navbar" class="z-30 fixed lg:sticky top-0 w-full"><div id="navbar-transition" class="absolute w-full h-full backdrop-blur flex-none transition-colors duration-500 border-b border-gray-500/5 dark:border-gray-300/[0.06] supports-backdrop-blur:bg-background-light/60 dark:bg-transparent"></div><div class="max-w-8xl mx-auto relative"><div class=""><div class="relative"><div class="flex items-center lg:px-12 h-16 min-w-0 px-4"><div class="h-full relative flex-1 flex items-center gap-x-4 min-w-0 border-b border-gray-500/5 dark:border-gray-300/[0.06] lg:border-none"><div class="flex-1 flex items-center gap-x-4"><a href="https://mintlify.com"><span class="sr-only">Mintlify home page</span><img class="w-auto h-7 relative object-contain block dark:hidden" src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/light.svg" alt="light logo"/><img class="w-auto h-7 relative object-contain hidden dark:block" src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/dark.svg" alt="dark logo"/></a><div class="flex items-center gap-x-2"></div></div><button type="button" class="hidden lg:flex relative flex-1 pointer-events-auto rounded-xl w-full items-center text-sm leading-6 py-1.5 pl-3.5 pr-3 text-gray-400 dark:text-white/50 bg-background-light dark:bg-background-dark dark:brightness-[1.1] dark:ring-1 dark:hover:brightness-[1.25] ring-1 ring-gray-400/20 hover:ring-gray-600/25 dark:ring-gray-600/30 dark:hover:ring-gray-500/30 focus:outline-primary justify-between truncate gap-2 min-w-[43px]" id="search-bar-entry"><div class="flex items-center gap-3 min-w-[42px]"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-search min-w-4 flex-none text-gray-700 hover:text-gray-800 dark:text-gray-300 hover:dark:text-gray-200"><circle cx="11" cy="11" r="8"></circle><path d="m21 21-4.3-4.3"></path></svg><div class="truncate min-w-0">Search or ask...</div></div></button><div class="flex-1 relative hidden lg:flex items-center ml-auto justify-end space-x-4"><nav class="text-sm"><ul class="flex space-x-6 items-center"><li><a href="https://mintlify.com/community" class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" target="_blank">Community</a></li><li><a class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" href="https://dashboard.mintlify.com/login">Log In</a></li><li class="block lg:hidden"><a class="whitespace-nowrap font-medium text-gray-600 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300" href="https://mintlify.com/start">Get Started</a></li><li class="whitespace-nowrap hidden lg:flex" id="topbar-cta-button"><a target="_blank" class="group px-4 py-1.5 relative inline-flex items-center text-sm font-medium" href="https://mintlify.com/start"><span class="absolute inset-0 bg-primary-dark rounded-full group-hover:opacity-[0.9]"></span><div class="mr-0.5 space-x-2.5 flex items-center"><span class="z-10 text-white">Get Started</span><svg width="3" height="24" viewBox="0 -9 3 24" class="h-5 rotate-0 overflow-visible text-white/90"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div></a></li></ul></nav><div class="flex items-center"><button class="group p-2 flex items-center justify-center" aria-label="Toggle dark mode"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" xmlns="http://www.w3.org/2000/svg" class="h-4 w-4 block text-gray-400 dark:hidden group-hover:text-gray-600"><g clip-path="url(#clip0_2880_7340)"><path d="M8 1.11133V2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 3.12891L12.2427 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M14.8889 8H14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 12.8711L12.2427 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8 14.8889V14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 12.8711L3.75735 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M1.11133 8H2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 3.12891L3.75735 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8.00043 11.7782C10.0868 11.7782 11.7782 10.0868 11.7782 8.00043C11.7782 5.91402 10.0868 4.22266 8.00043 4.22266C5.91402 4.22266 4.22266 5.91402 4.22266 8.00043C4.22266 10.0868 5.91402 11.7782 8.00043 11.7782Z" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></g><defs><clipPath id="clip0_2880_7340"><rect width="16" height="16" fill="white"></rect></clipPath></defs></svg><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-moon h-4 w-4 hidden dark:block text-gray-500 dark:group-hover:text-gray-300"><path d="M12 3a6 6 0 0 0 9 9 9 9 0 1 1-9-9Z"></path></svg></button></div></div><div class="flex lg:hidden items-center gap-2"><button type="button" class="text-gray-500 w-8 h-8 flex items-center justify-center hover:text-gray-600 dark:text-gray-400 dark:hover:text-gray-300" id="search-bar-entry-mobile"><span class="sr-only">Search...</span><svg class="h-4 w-4 bg-gray-500 dark:bg-gray-400 hover:bg-gray-600 dark:hover:bg-gray-300" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/magnifying-glass.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/magnifying-glass.svg);mask-repeat:no-repeat;mask-position:center"></svg></button><button aria-label="More actions" class="h-7 w-5 flex items-center justify-end"><svg class="h-4 w-4 bg-gray-500 dark:bg-gray-400 hover:bg-gray-600 dark:hover:bg-gray-300" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/ellipsis-vertical.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/ellipsis-vertical.svg);mask-repeat:no-repeat;mask-position:center"></svg></button></div></div></div><div class="flex items-center h-14 py-4 px-5 lg:hidden"><button type="button" class="text-gray-500 hover:text-gray-600 dark:text-gray-400 dark:hover:text-gray-300"><span class="sr-only">Navigation</span><svg class="h-4" fill="currentColor" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"></path></svg></button><div class="ml-4 flex text-sm leading-6 whitespace-nowrap min-w-0 space-x-3"><div class="flex items-center space-x-3"><span>Getting Started</span><svg width="3" height="24" viewBox="0 -9 3 24" class="h-5 rotate-0 overflow-visible fill-gray-400"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg></div><div class="font-semibold text-gray-900 truncate dark:text-gray-200">Quickstart</div></div></div></div></div></div></div></div><div class="relative w-full lg:ml-[19rem] flex px-4 pt-40 lg:pt-10 lg:pl-16 lg:pr-10"><div class="flex flex-col box-border w-full relative grow mx-auto max-w-xl 2xl:max-w-2xl xl:w-[calc(100%-28rem)]" id="content-area"><header id="header" class="relative"><div class="mt-0.5 space-y-2.5"><div class="eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold">Getting Started</div><div class="flex items-center"><h1 class="inline-block text-2xl sm:text-3xl text-gray-900 tracking-tight dark:text-gray-200 font-semibold">Quickstart</h1></div></div><div class="mt-2 text-lg prose prose-gray dark:prose-invert"><p>Start building modern documentation in under five minutes</p></div></header><div class="flex flex-col gap-8"></div><div class="relative mt-8 prose prose-gray dark:prose-invert"><div><div class="p-2 not-prose relative bg-gray-50/50 rounded-2xl overflow-hidden dark:bg-gray-800/25"><div style="background-position:10px 10px" class="absolute inset-0 bg-grid-neutral-200/20 [mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,0.6))] dark:bg-grid-white/5 dark:[mask-image:linear-gradient(0deg,rgba(255,255,255,0.1),rgba(255,255,255,0.5))]"></div><div class="relative rounded-xl overflow-hidden flex justify-center"></div><div class="absolute inset-0 pointer-events-none border border-black/5 rounded-2xl dark:border-white/5"></div></div></div> <h2 class="flex whitespace-pre-wrap group font-semibold font-semibold" id="getting-started"><div class="absolute"><a href="#getting-started" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Getting Started</span></h2> <p>Welcome! Follow the instructions below to learn how to deploy, update and supercharge your documentation with Mintlify.</p> <h3 class="flex whitespace-pre-wrap group font-semibold font-semibold" id="creating-the-repository"><div class="absolute"><a href="#creating-the-repository" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Creating the Repository</span></h3> <p>Mintlify docs are rendered from MDX files and configurations defined in our <a href="https://github.com/mintlify/starter" target="_blank" rel="noreferrer">starter kit</a>. We use GitHub to integrate your docs with your code, and make source control effortless. Onboard through the <a href="https://dashboard.mintlify.com" target="_blank" rel="noreferrer">dashboard</a> or clone our <a href="https://github.com/mintlify/starter" target="_blank" rel="noreferrer">starter kit</a> to get started.</p> <div class="[&>div]:border-0 [&>div]:rounded-none [&>div>button]:rounded-none [&>div]:mb-0 overflow-hidden mt-0 mb-3 rounded-xl prose prose-gray dark:prose-invert divide-y divide-inherit border dark:border-gray-800/50"><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="install-the-github-app accordion children" aria-expanded="false"><div id="install-the-github-app" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/message-bot.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/message-bot.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Install the GitHub app</p></div></button><div id="install-the-github-app accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the <a href="https://dashboard.mintlify.com/settings" target="_blank" rel="noreferrer">dashboard</a>, on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.</p><div><div class="p-2 not-prose relative bg-gray-50/50 rounded-2xl overflow-hidden dark:bg-gray-800/25"><div style="background-position:10px 10px" class="absolute inset-0 bg-grid-neutral-200/20 [mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,0.6))] dark:bg-grid-white/5 dark:[mask-image:linear-gradient(0deg,rgba(255,255,255,0.1),rgba(255,255,255,0.5))]"></div><div class="relative rounded-xl overflow-hidden flex justify-center"><p></p></div><div class="absolute inset-0 pointer-events-none border border-black/5 rounded-2xl dark:border-white/5"></div></div></div></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="monorepo-setup accordion children" aria-expanded="false"><div id="monorepo-setup" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code-branch.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code-branch.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Monorepo Setup</p></div></button><div id="monorepo-setup accordion children" class="mt-2 mb-4 mx-6 hidden"><p>If you want your docs to live alongside your code as a monorepo setup, you can: 1. Move your docs content to your monorepo. 2. Specify the path to your <code>docs.json</code> in the <a href="https://dashboard.mintlify.com/settings/deployment/git-settings" target="_blank" rel="noreferrer">dashboard</a></p><div><div class="p-2 not-prose relative bg-gray-50/50 rounded-2xl overflow-hidden dark:bg-gray-800/25"><div style="background-position:10px 10px" class="absolute inset-0 bg-grid-neutral-200/20 [mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,0.6))] dark:bg-grid-white/5 dark:[mask-image:linear-gradient(0deg,rgba(255,255,255,0.1),rgba(255,255,255,0.5))]"></div><div class="relative rounded-xl overflow-hidden flex justify-center"></div><div class="absolute inset-0 pointer-events-none border border-black/5 rounded-2xl dark:border-white/5"></div></div></div></div></div></div> <h3 class="flex whitespace-pre-wrap group font-semibold font-semibold" id="updating-the-content"><div class="absolute"><a href="#updating-the-content" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Updating the Content</span></h3> <p>Mintlify enables you to easily customize the style, structure, and content of your docs.</p> <div class="[&>div]:border-0 [&>div]:rounded-none [&>div>button]:rounded-none [&>div]:mb-0 overflow-hidden mt-0 mb-3 rounded-xl prose prose-gray dark:prose-invert divide-y divide-inherit border dark:border-gray-800/50"><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="editing-locally-recommended-for-developers accordion children" aria-expanded="false"><div id="editing-locally-recommended-for-developers" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/rectangle-terminal.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/rectangle-terminal.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Editing locally (recommended for developers)</p></div></button><div id="editing-locally-recommended-for-developers accordion children" class="mt-2 mb-4 mx-6 hidden"><ol> <li>Install <a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git" target="_blank" rel="noreferrer">git</a>.</li> <li>Once git is installed, clone your docs repository using <code>git clone <your-repo></code>. If you haven’t set it up yet, now would be a good time to do so with these <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent" target="_blank" rel="noreferrer">SSH keys</a>.</li> <li>Use your favorite IDE to open the repository.</li> <li>Install our Mintlify CLI to preview changes with <code>npm i -g mintlify</code>.</li> </ol><p>Learn more about this in our <a href="/docs/development">local development guide</a>.</p></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="editing-with-the-web-editor accordion children" aria-expanded="false"><div id="editing-with-the-web-editor" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/pen-to-square.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/pen-to-square.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Editing with the web editor</p></div></button><div id="editing-with-the-web-editor accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Learn more about how to use the web editor on our <a href="/docs/web-editor">guide</a>.</p></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="customizing-to-your-brand accordion children" aria-expanded="false"><div id="customizing-to-your-brand" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/palette.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/palette.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Customizing to your brand</p></div></button><div id="customizing-to-your-brand accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Easily customize colors, logos and buttons among other configurations in our <code>docs.json</code> file. Start with these basic configurations:</p><div class="mt-5 mb-8 not-prose rounded-2xl relative text-gray-50 bg-[#0F1117] dark:bg-codeblock border border-transparent dark:border-gray-800/50 codeblock-dark"><div class="min-w-full relative text-sm leading-6 children:!my-0 children:!shadow-none children:!bg-transparent transition-[height] duration-300 ease-in-out" style="font-variant-ligatures:none;height:auto"><div class="overflow-x-auto h-full p-5 overflow-y-hidden scrollbar-thin scrollbar-thumb-rounded scrollbar-thumb-white/20 dark:scrollbar-thumb-white/20 hover:scrollbar-thumb-white/25 dark:hover:scrollbar-thumb-white/25 active:scrollbar-thumb-white/25 dark:active:scrollbar-thumb-white/25"><pre class="language-json"><code class="language-json"><span class=""><span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"Your Company"</span></span> <span class=""><span class="token property">"logo"</span><span class="token operator">:</span> <span class="token punctuation">{</span></span> <span class=""> <span class="token property">"light"</span><span class="token operator">:</span> <span class="token string">"/logo/light.svg"</span><span class="token punctuation">,</span></span> <span class=""> <span class="token property">"dark"</span><span class="token operator">:</span> <span class="token string">"/logo/dark.svg"</span><span class="token punctuation">,</span></span> <span class=""> <span class="token property">"href"</span><span class="token operator">:</span> <span class="token string">"https://yourcompany.com"</span></span> <span class=""><span class="token punctuation">}</span><span class="token punctuation">,</span></span> <span class=""><span class="token property">"favicon"</span><span class="token operator">:</span> <span class="token string">"/favicon.svg"</span><span class="token punctuation">,</span></span> <span class=""><span class="token property">"colors"</span><span class="token operator">:</span> <span class="token punctuation">{</span></span> <span class=""> <span class="token property">"primary"</span><span class="token operator">:</span> <span class="token string">"#2AB673"</span><span class="token punctuation">,</span></span> <span class=""> <span class="token property">"light"</span><span class="token operator">:</span> <span class="token string">"#55D799"</span><span class="token punctuation">,</span></span> <span class=""> <span class="token property">"dark"</span><span class="token operator">:</span> <span class="token string">"#117866"</span><span class="token punctuation">,</span></span> <span class=""><span class="token punctuation">}</span><span class="token punctuation">,</span></span> </code></pre></div></div></div><p>A full list of supported configurations can be found at <a href="/docs/settings/global">global settings</a>.</p></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="adding-content accordion children" aria-expanded="false"><div id="adding-content" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/pencil.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/pencil.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Adding content</p></div></button><div id="adding-content accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Add content with simple MDX files. Initiate your pages with this template:</p><div class="mt-5 mb-8 not-prose rounded-2xl relative text-gray-50 bg-[#0F1117] dark:bg-codeblock border border-transparent dark:border-gray-800/50 codeblock-dark"><div class="min-w-full relative text-sm leading-6 children:!my-0 children:!shadow-none children:!bg-transparent transition-[height] duration-300 ease-in-out" style="font-variant-ligatures:none;height:auto"><div class="overflow-x-auto h-full p-5 overflow-y-hidden scrollbar-thin scrollbar-thumb-rounded scrollbar-thumb-white/20 dark:scrollbar-thumb-white/20 hover:scrollbar-thumb-white/25 dark:hover:scrollbar-thumb-white/25 active:scrollbar-thumb-white/25 dark:active:scrollbar-thumb-white/25"><pre class="language-md"><code class="language-md"><span class=""><span class="token hr punctuation">---</span></span> <span class="">title: "Page Title"</span> <span class="">sidebarTitle: "Sidebar title (optional - if different from page title)"</span> <span class="">description: "Subtitle (optional)"</span> <span class=""><span class="token hr punctuation">---</span></span> </code></pre></div></div></div><p>Learn more about adding images, tables, lists, and more using the <a href="/docs/text">MDX syntax</a>. We also offer a <a href="/docs/content/components">wide array of components</a>.</p></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="pushing-changes accordion children" aria-expanded="false"><div id="pushing-changes" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/rocket.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/rocket.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Pushing changes</p></div></button><div id="pushing-changes accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Once ready, commit and push your changes to update your docs site. Here is a <a href="https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push" target="_blank" rel="noreferrer">guide</a> on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our <a href="https://dashboard.mintlify.com" target="_blank" rel="noreferrer">dashboard</a>.</p><div><div class="p-2 not-prose relative bg-gray-50/50 rounded-2xl overflow-hidden dark:bg-gray-800/25"><div style="background-position:10px 10px" class="absolute inset-0 bg-grid-neutral-200/20 [mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,0.6))] dark:bg-grid-white/5 dark:[mask-image:linear-gradient(0deg,rgba(255,255,255,0.1),rgba(255,255,255,0.5))]"></div><div class="relative rounded-xl overflow-hidden flex justify-center"><p></p></div><div class="absolute inset-0 pointer-events-none border border-black/5 rounded-2xl dark:border-white/5"></div></div></div></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="generating-api-references accordion children" aria-expanded="false"><div id="generating-api-references" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code-branch.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/code-branch.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Generating API references</p></div></button><div id="generating-api-references accordion children" class="mt-2 mb-4 mx-6 hidden"><p>You can easily set up your API references using an OpenAPI document.</p><ol> <li>Add your <code>openapi.yaml</code> or <code>openapi.json</code> file into your docs repository or define the <code>openapi</code> field in <code>docs.json</code> with a URL.</li> </ol><div class="mt-5 mb-8 not-prose rounded-2xl relative text-gray-50 bg-[#0F1117] dark:bg-codeblock border border-transparent dark:border-gray-800/50 codeblock-dark"><div class="min-w-full relative text-sm leading-6 children:!my-0 children:!shadow-none children:!bg-transparent transition-[height] duration-300 ease-in-out" style="font-variant-ligatures:none;height:auto"><div class="overflow-x-auto h-full p-5 overflow-y-hidden scrollbar-thin scrollbar-thumb-rounded scrollbar-thumb-white/20 dark:scrollbar-thumb-white/20 hover:scrollbar-thumb-white/25 dark:hover:scrollbar-thumb-white/25 active:scrollbar-thumb-white/25 dark:active:scrollbar-thumb-white/25"><pre class="language-json"><code class="language-json"><span class=""><span class="token property">"openapi"</span><span class="token operator">:</span> <span class="token string">"link-to-your-openapi-file"</span></span> </code></pre></div></div></div><ol start="2"> <li>Use our <a href="/docs/api-playground/openapi/setup#autogenerate-files-recommended">scraper</a> to autogenerate your OpenAPI endpoints files as:</li> </ol><div class="mt-5 mb-8 not-prose rounded-2xl relative text-gray-50 bg-[#0F1117] dark:bg-codeblock border border-transparent dark:border-gray-800/50 codeblock-dark"><div class="min-w-full relative text-sm leading-6 children:!my-0 children:!shadow-none children:!bg-transparent transition-[height] duration-300 ease-in-out" style="font-variant-ligatures:none;height:auto"><div class="overflow-x-auto h-full p-5 overflow-y-hidden scrollbar-thin scrollbar-thumb-rounded scrollbar-thumb-white/20 dark:scrollbar-thumb-white/20 hover:scrollbar-thumb-white/25 dark:hover:scrollbar-thumb-white/25 active:scrollbar-thumb-white/25 dark:active:scrollbar-thumb-white/25"><pre class="language-bash"><code class="language-bash"><span class="">npx @mintlify/scraping@latest openapi-file <span class="token operator"><</span>path-or-url-to-openapi-file<span class="token operator">></span></span> </code></pre></div></div></div><ol start="3"> <li>Finally, include the generated endpoint MDX files to your <code>docs.json</code> under <code>navigation</code>.</li> </ol><p>For a complete guide on using Mintlify with OpenAPI, check out <a href="/docs/api-playground/openapi/setup">this guide</a>. <a href="/docs/api-playground/openapi/writing-openapi">This guide</a> explains how to configure your API authentication methods. For manual API references definition, explore <a href="/docs/api-playground/overview">our syntax</a>.</p></div></div><div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="adding-analytics accordion children" aria-expanded="false"><div id="adding-analytics" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/chart-simple.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/chart-simple.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Adding analytics</p></div></button><div id="adding-analytics accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your <a href="https://dashboard.mintlify.com/analytics" target="_blank" rel="noreferrer">dashboard</a>.</p><p>We also support integrations with a range of analytics providers. You can find the list of providers <a href="/docs/integrations/analytics/overview">here</a>.</p></div></div></div> <div class="my-4 px-5 py-4 overflow-hidden rounded-2xl flex gap-3 border border-sky-500/20 bg-sky-50/50 dark:border-sky-500/30 dark:bg-sky-500/10"><div class="mt-0.5 w-4"><svg width="14" height="14" viewBox="0 0 14 14" fill="currentColor" xmlns="http://www.w3.org/2000/svg" class="w-4 h-4 text-sky-500" aria-label="Note"><path fill-rule="evenodd" clip-rule="evenodd" d="M7 1.3C10.14 1.3 12.7 3.86 12.7 7C12.7 10.14 10.14 12.7 7 12.7C5.48908 12.6974 4.0408 12.096 2.97241 11.0276C1.90403 9.9592 1.30264 8.51092 1.3 7C1.3 3.86 3.86 1.3 7 1.3ZM7 0C3.14 0 0 3.14 0 7C0 10.86 3.14 14 7 14C10.86 14 14 10.86 14 7C14 3.14 10.86 0 7 0ZM8 3H6V8H8V3ZM8 9H6V11H8V9Z"></path></svg></div><div class="text-sm prose min-w-0 text-sky-900 dark:text-sky-200"><p>We provide a white-glove migration service as part of our Enterprise plan. Interested? You can request it by <a href="/cdn-cgi/l/email-protection#8cffede0e9ffcce1e5e2f8e0e5eaf5a2efe3e1" target="_blank" rel="noreferrer">contacting us</a>.</p></div></div> <h3 class="flex whitespace-pre-wrap group font-semibold font-semibold" id="publishing"><div class="absolute"><a href="#publishing" class="-ml-10 flex items-center opacity-0 border-0 group-hover:opacity-100" aria-label="Navigate to header"><div class="w-6 h-6 text-gray-400 rounded-md flex items-center justify-center zinc-box bg-white ring-1 ring-gray-400/30 dark:ring-gray-700/25 hover:ring-gray-400/60 dark:hover:ring-white/20"><svg xmlns="http://www.w3.org/2000/svg" fill="gray" height="12px" viewBox="0 0 576 512"><path d="M0 256C0 167.6 71.6 96 160 96h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C98.1 144 48 194.1 48 256s50.1 112 112 112h72c13.3 0 24 10.7 24 24s-10.7 24-24 24H160C71.6 416 0 344.4 0 256zm576 0c0 88.4-71.6 160-160 160H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c61.9 0 112-50.1 112-112s-50.1-112-112-112H344c-13.3 0-24-10.7-24-24s10.7-24 24-24h72c88.4 0 160 71.6 160 160zM184 232H392c13.3 0 24 10.7 24 24s-10.7 24-24 24H184c-13.3 0-24-10.7-24-24s10.7-24 24-24z"></path></svg></div></a></div><span class="cursor-pointer">Publishing</span></h3> <div role="button" class="border-standard rounded-2xl mb-3 overflow-hidden bg-background-light dark:bg-codeblock"><button class="relative not-prose flex flex-row items-center content-center w-full py-4 px-5 space-x-2 hover:bg-gray-100 hover:dark:bg-gray-800 rounded-t-xl" aria-controls="adding-a-custom-domain accordion children" aria-expanded="false"><div id="adding-a-custom-domain" class="absolute -top-[4.5rem]"></div><div class="mr-0.5"><svg class="h-3 w-3 transition bg-gray-700 dark:bg-gray-400 duration-75" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/solid/caret-right.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="h-4 w-4 fill-gray-800 dark:fill-gray-100 text-gray-800 dark:text-gray-100"><svg class="w-4 h-4 bg-gray-800 dark:bg-gray-100" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/star.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/regular/star.svg);mask-repeat:no-repeat;mask-position:center"></svg></div><div class="leading-tight text-left"><p class="m-0 font-medium text-gray-900 dark:text-gray-200">Adding a custom domain</p></div></button><div id="adding-a-custom-domain accordion children" class="mt-2 mb-4 mx-6 hidden"><p>Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.</p><p>Navigate to your <a href="https://www.dashboard.mintlify.com/settings" target="_blank" rel="noreferrer">dashboard settings</a> to add a custom domain.</p><div><div class="p-2 not-prose relative bg-gray-50/50 rounded-2xl overflow-hidden dark:bg-gray-800/25"><div style="background-position:10px 10px" class="absolute inset-0 bg-grid-neutral-200/20 [mask-image:linear-gradient(0deg,#fff,rgba(255,255,255,0.6))] dark:bg-grid-white/5 dark:[mask-image:linear-gradient(0deg,rgba(255,255,255,0.1),rgba(255,255,255,0.5))]"></div><div class="relative rounded-xl overflow-hidden flex justify-center"></div><div class="absolute inset-0 pointer-events-none border border-black/5 rounded-2xl dark:border-white/5"></div></div></div></div></div> <p>Congrats! You’ve set up your Mintlify Docs and it’s looking amazing! Need support or want to give some feedback? You can join our <a href="https://mintlify.com/community" target="_blank" rel="noreferrer">community</a> or drop us an email at <a href="/cdn-cgi/l/email-protection#1e6d6b6e6e716c6a5e7377706a72777867307d7173" target="_blank" rel="noreferrer"><span class="__cf_email__" data-cfemail="eb989e9b9b84999fab8682859f87828d92c5888486">[email protected]</span></a>.</p></div><div class="leading-6 mt-14"><div class="pb-16 w-full"><div class="flex flex-col gap-y-4 xl:flex-col xl:gap-6 min-[1400px]:flex-row md:flex-row md:justify-end"><div class="flex flex-row gap-5 items-center grow justify-between md:justify-start xl:justify-between min-[1400px]:justify-start"><p class="text-sm text-gray-600 dark:text-gray-400">Was this page helpful?</p><div class="flex flex-row gap-3 items-center"><button class="px-3.5 py-2 flex flex-row gap-3 items-center border-standard rounded-xl text-gray-600 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 bg-white/50 dark:bg-codeblock/50 hover:border-gray-500 hover:dark:border-gray-500"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" class="fill-current"><path d="M10.1187 1.08741C8.925 0.746789 7.67813 1.43741 7.3375 2.63116L7.15938 3.25616C7.04375 3.66241 6.83438 4.03741 6.55 4.34991L4.94688 6.11241C4.66875 6.41866 4.69062 6.89366 4.99687 7.17179C5.30312 7.44991 5.77813 7.42804 6.05625 7.12179L7.65938 5.35929C8.1 4.87491 8.42188 4.29679 8.6 3.66866L8.77812 3.04366C8.89062 2.64679 9.30625 2.41554 9.70625 2.52804C10.1063 2.64054 10.3344 3.05616 10.2219 3.45616L10.0437 4.08116C9.86562 4.70304 9.58437 5.29054 9.2125 5.81554C9.05 6.04366 9.03125 6.34366 9.15938 6.59366C9.2875 6.84366 9.54375 6.99991 9.825 6.99991H14C14.275 6.99991 14.5 7.22491 14.5 7.49991C14.5 7.71241 14.3656 7.89679 14.175 7.96866C13.9438 8.05616 13.7688 8.24992 13.7094 8.49054C13.65 8.73117 13.7125 8.98429 13.875 9.16866C13.9531 9.25616 14 9.37179 14 9.49991C14 9.74366 13.825 9.94679 13.5938 9.99054C13.3375 10.0405 13.1219 10.2187 13.0312 10.4624C12.9406 10.7062 12.9813 10.9843 13.1438 11.1905C13.2094 11.2749 13.25 11.3812 13.25 11.4999C13.25 11.7093 13.1187 11.8937 12.9312 11.9655C12.5719 12.1062 12.3781 12.4937 12.4812 12.8655C12.4937 12.9062 12.5 12.953 12.5 12.9999C12.5 13.2749 12.275 13.4999 12 13.4999H8.95312C8.55937 13.4999 8.17188 13.3843 7.84375 13.1655L5.91563 11.8812C5.57188 11.6499 5.10625 11.7437 4.875 12.0905C4.64375 12.4374 4.7375 12.8999 5.08437 13.1312L7.0125 14.4155C7.5875 14.7999 8.2625 15.003 8.95312 15.003H12C13.0844 15.003 13.9656 14.1405 14 13.0655C14.4563 12.6999 14.75 12.1374 14.75 11.503C14.75 11.3624 14.7344 11.228 14.7094 11.0968C15.1906 10.7312 15.5 10.153 15.5 9.50304C15.5 9.29991 15.4688 9.10304 15.4125 8.91866C15.775 8.55304 16 8.05304 16 7.49991C16 6.39679 15.1063 5.49991 14 5.49991H11.1156C11.2625 5.17491 11.3875 4.83741 11.4844 4.49366L11.6625 3.86866C12.0031 2.67491 11.3125 1.42804 10.1187 1.08741ZM1 5.99991C0.446875 5.99991 0 6.44679 0 6.99991V13.9999C0 14.553 0.446875 14.9999 1 14.9999H3C3.55313 14.9999 4 14.553 4 13.9999V6.99991C4 6.44679 3.55313 5.99991 3 5.99991H1Z"></path></svg><small class="text-sm font-normal leading-4 ">Yes</small></button><button class="px-3.5 py-2 flex flex-row gap-3 items-center border-standard rounded-xl text-gray-600 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300 bg-white/50 dark:bg-codeblock/50 hover:border-gray-500 hover:dark:border-gray-500"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16" class="fill-current"><path d="M10.1187 14.9124C8.925 15.253 7.67813 14.5624 7.3375 13.3687L7.15938 12.7437C7.04375 12.3374 6.83438 11.9624 6.55 11.6499L4.94688 9.8874C4.66875 9.58115 4.69062 9.10615 4.99687 8.82803C5.30312 8.5499 5.77813 8.57178 6.05625 8.87803L7.65938 10.6405C8.1 11.1249 8.42188 11.703 8.6 12.3312L8.77812 12.9562C8.89062 13.353 9.30625 13.5843 9.70625 13.4718C10.1063 13.3593 10.3344 12.9437 10.2219 12.5437L10.0437 11.9187C9.86562 11.2968 9.58437 10.7093 9.2125 10.1843C9.05 9.95615 9.03125 9.65615 9.15938 9.40615C9.2875 9.15615 9.54375 8.9999 9.825 8.9999H14C14.275 8.9999 14.5 8.7749 14.5 8.4999C14.5 8.2874 14.3656 8.10303 14.175 8.03115C13.9438 7.94365 13.7688 7.7499 13.7094 7.50928C13.65 7.26865 13.7125 7.01553 13.875 6.83115C13.9531 6.74365 14 6.62803 14 6.4999C14 6.25615 13.825 6.05303 13.5938 6.00928C13.3375 5.95928 13.1219 5.78115 13.0312 5.53428C12.9406 5.2874 12.9813 5.0124 13.1438 4.80615C13.2094 4.72178 13.25 4.61553 13.25 4.49678C13.25 4.2874 13.1187 4.10303 12.9312 4.03115C12.5719 3.89053 12.3781 3.50303 12.4812 3.13115C12.4937 3.09053 12.5 3.04365 12.5 2.99678C12.5 2.72178 12.275 2.49678 12 2.49678H8.95312C8.55937 2.49678 8.17188 2.6124 7.84375 2.83115L5.91563 4.11553C5.57188 4.34678 5.10625 4.25303 4.875 3.90615C4.64375 3.55928 4.7375 3.09678 5.08437 2.86553L7.0125 1.58115C7.5875 1.19678 8.2625 0.993652 8.95312 0.993652H12C13.0844 0.993652 13.9656 1.85615 14 2.93115C14.4563 3.29678 14.75 3.85928 14.75 4.49365C14.75 4.63428 14.7344 4.76865 14.7094 4.8999C15.1906 5.26553 15.5 5.84365 15.5 6.49365C15.5 6.69678 15.4688 6.89365 15.4125 7.07803C15.775 7.44678 16 7.94678 16 8.4999C16 9.60303 15.1063 10.4999 14 10.4999H11.1156C11.2625 10.8249 11.3875 11.1624 11.4844 11.5062L11.6625 12.1312C12.0031 13.3249 11.3125 14.5718 10.1187 14.9124ZM1 11.9999C0.446875 11.9999 0 11.553 0 10.9999V3.9999C0 3.44678 0.446875 2.9999 1 2.9999H3C3.55313 2.9999 4 3.44678 4 3.9999V10.9999C4 11.553 3.55313 11.9999 3 11.9999H1Z"></path></svg><small class="text-sm font-normal leading-4 ">No</small></button></div></div><div class="flex flex-row gap-3 justify-end"></div></div></div><div class="w-full rounded-xl flex bg-gray-50/80 dark:bg-white/[0.03] p-1 text-sm mb-10"><a class="group w-full" href="/docs/development"><div class="flex-1 flex items-center justify-end h-16 bg-background-light dark:bg-background-dark hover:ring-1 hover:ring-gray-200 dark:hover:ring-gray-800 rounded-xl"><div class="flex flex-col items-end justify-center px-5"><span class="font-semibold text-gray-800 dark:text-gray-200 text-right">Local Development</span><span class="hidden text-right text-gray-500 dark:text-gray-400 lg:block truncate lg:w-96">Preview changes locally to update your docs</span></div><div class="w-px h-8 bg-gray-100 dark:bg-white/5"></div><div class="pl-5 pr-3 text-gray-600 dark:text-gray-400 flex items-center space-x-1.5"><span class="text-gray-500 dark:text-gray-400 font-medium tracking-tight group-hover:text-gray-900 dark:group-hover:text-gray-100">Next</span><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="3" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-chevron-right size-3 text-gray-300 dark:text-gray-700 group-hover:text-gray-600 dark:group-hover:text-gray-400"><path d="m9 18 6-6-6-6"></path></svg></div></div></a></div></div></div><div class="hidden xl:flex self-start sticky h-[calc(100vh-4rem)] top-10" id="content-side-layout"><div class="z-10 hidden xl:flex pl-10 box-border w-[19rem]" id="table-of-contents"><div id="table-of-contents-content" class="text-gray-600 text-sm leading-6 w-[16.5rem] overflow-y-auto space-y-2"><div class="text-gray-700 dark:text-gray-300 font-medium flex items-center space-x-2"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" stroke-width="2" xmlns="http://www.w3.org/2000/svg" class="h-3 w-3"><path d="M2.44434 12.6665H13.5554" stroke-linecap="round" stroke-linejoin="round"></path><path d="M2.44434 3.3335H13.5554" stroke-linecap="round" stroke-linejoin="round"></path><path d="M2.44434 8H7.33323" stroke-linecap="round" stroke-linejoin="round"></path></svg><span>On this page</span></div><ul><li><a href="#getting-started" class="py-1 block font-medium border-l pl-4 border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Getting Started</a></li><li class="border-l pl-4 border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20"><a style="margin-left:1rem" href="#creating-the-repository" class="group flex items-start py-1 whitespace-pre-wrap text-gray-500 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Creating the Repository</a></li><li class="border-l pl-4 border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20"><a style="margin-left:1rem" href="#updating-the-content" class="group flex items-start py-1 whitespace-pre-wrap text-gray-500 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Updating the Content</a></li><li class="border-l pl-4 border-gray-950/5 dark:border-white/10 hover:border-gray-950/20 dark:hover:border-white/20"><a style="margin-left:1rem" href="#publishing" class="group flex items-start py-1 whitespace-pre-wrap text-gray-500 hover:text-gray-900 dark:text-gray-400 dark:hover:text-gray-300">Publishing</a></li></ul></div></div></div></div></div><footer id="footer" class="flex flex-col items-center mx-auto border-t border-gray-100 dark:border-gray-800/50 lg:ml-[19rem]"><div class="flex w-full flex-col gap-12 justify-between px-8 py-16 md:py-20 lg:py-28 max-w-[984px] z-0"><div class="flex flex-col md:flex-row gap-8 justify-between min-h-[76px]"><div class="flex md:flex-col justify-between items-center md:items-start min-w-16 md:min-w-20 lg:min-w-48 md:gap-y-24"><a href="https://mintlify.com"><span class="sr-only">Mintlify home page</span><img class="w-auto relative object-contain block dark:hidden max-w-48 h-[26px]" src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/light.svg" alt="light logo"/><img class="w-auto relative object-contain hidden dark:block max-w-48 h-[26px]" src="https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/dark.svg" alt="dark logo"/></a><div class="flex gap-3 min-w-[140px] max-w-[492px] flex-wrap h-fit md:hidden justify-end"><a href="https://x.com/mintlify" target="_blank"><span class="sr-only">x</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://www.linkedin.com/company/mintlify" target="_blank"><span class="sr-only">linkedin</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://github.com/mintlify" target="_blank"><span class="sr-only">github</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://mintlify.com/community" target="_blank"><span class="sr-only">slack</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/slack.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/slack.svg);mask-repeat:no-repeat;mask-position:center"></svg></a></div></div><div class="flex flex-col sm:grid max-md:!grid-cols-2 gap-8 flex-1" style="grid-template-columns:repeat(3, minmax(0, 1fr))"><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">Resources</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/customers" target="_blank" rel="noreferrer">Customers</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/enterprise" target="_blank" rel="noreferrer">Enterprise</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/preview" target="_blank" rel="noreferrer">Request Preview</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/docs/integrations/analytics/overview" target="_blank" rel="noreferrer">Integrations</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://github.com/mintlify/themes" target="_blank" rel="noreferrer">Templates</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/love" target="_blank" rel="noreferrer">Wall of Love</a></div></div><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">Company</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/careers" target="_blank" rel="noreferrer">Careers</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/blog" target="_blank" rel="noreferrer">Blog</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://feedback.mintlify.com/roadmap" target="_blank" rel="noreferrer">Public Roadmap</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/security/responsible-disclosure" target="_blank" rel="noreferrer">Security</a></div></div><div class="flex flex-col gap-4 flex-1 whitespace-nowrap w-full md:items-center"><div class="flex gap-4 flex-col"><p class="text-sm font-semibold text-gray-950 dark:text-white mb-1">Legal</p><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/legal/privacy" target="_blank" rel="noreferrer">Privacy Policy</a><a class="text-sm max-w-36 whitespace-normal md:truncate text-gray-950/50 dark:text-white/50 hover:text-gray-950/70 dark:hover:text-white/70" href="https://mintlify.com/legal/terms" target="_blank" rel="noreferrer">Terms of Service</a></div></div></div><div class="gap-3 min-w-[140px] max-w-[492px] flex-wrap hidden md:flex justify-end"><a href="https://x.com/mintlify" target="_blank"><span class="sr-only">x</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/x-twitter.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://www.linkedin.com/company/mintlify" target="_blank"><span class="sr-only">linkedin</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/linkedin.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://github.com/mintlify" target="_blank"><span class="sr-only">github</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/github.svg);mask-repeat:no-repeat;mask-position:center"></svg></a><a href="https://mintlify.com/community" target="_blank"><span class="sr-only">slack</span><svg class="w-5 h-5 bg-gray-500 dark:bg-gray-600 hover:bg-gray-600 dark:hover:bg-gray-500" style="-webkit-mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/slack.svg);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;mask-image:url(https://mintlify.b-cdn.net/v6.6.0/brands/slack.svg);mask-repeat:no-repeat;mask-position:center"></svg></a></div></div><div class="h-[1px] w-full bg-gray-100 dark:bg-white/5"></div><div class="flex items-center justify-between"><div class="sm:flex"><a href="https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=mintlify" target="_blank" rel="noreferrer" class="text-sm text-gray-500 dark:text-gray-400 hover:text-gray-700 dark:hover:text-gray-300">Powered by Mintlify</a></div><div class="flex items-center gap-2"><button aria-label="Switch to system theme" data-testid="mode-switch-system" class="p-1.5 rounded-lg bg-gray-200 dark:bg-gray-800 text-gray-600 dark:text-gray-400"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg" class="size-4"><g clip-path="url(#clip0_2736_5814)"><path d="M5.11133 14.4444C5.78511 14.232 6.78066 14 8.00022 14C8.70688 14 9.72555 14.0782 10.8891 14.4444" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8 11.7778V14.0001" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.6668 2.44434H3.33344C2.3516 2.44434 1.55566 3.24027 1.55566 4.22211V9.99989C1.55566 10.9817 2.3516 11.7777 3.33344 11.7777H12.6668C13.6486 11.7777 14.4446 10.9817 14.4446 9.99989V4.22211C14.4446 3.24027 13.6486 2.44434 12.6668 2.44434Z" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></g><defs><clipPath id="clip0_2736_5814"><rect width="16" height="16" fill="white"></rect></clipPath></defs></svg></button><button aria-label="Switch to light theme" data-testid="mode-switch-light" class="p-1.5 rounded-lg text-gray-400 dark:text-gray-600 hover:text-gray-600 dark:hover:text-gray-400"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" stroke="currentColor" xmlns="http://www.w3.org/2000/svg" class="size-4"><g clip-path="url(#clip0_2880_7340)"><path d="M8 1.11133V2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 3.12891L12.2427 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M14.8889 8H14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.8711 12.8711L12.2427 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8 14.8889V14" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 12.8711L3.75735 12.2427" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M1.11133 8H2.00022" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3.12891 3.12891L3.75735 3.75735" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path><path d="M8.00043 11.7782C10.0868 11.7782 11.7782 10.0868 11.7782 8.00043C11.7782 5.91402 10.0868 4.22266 8.00043 4.22266C5.91402 4.22266 4.22266 5.91402 4.22266 8.00043C4.22266 10.0868 5.91402 11.7782 8.00043 11.7782Z" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"></path></g><defs><clipPath id="clip0_2880_7340"><rect width="16" height="16" fill="white"></rect></clipPath></defs></svg></button><button aria-label="Switch to dark theme" data-testid="mode-switch-dark" class="p-1.5 rounded-lg text-gray-400 dark:text-gray-600 hover:text-gray-600 dark:hover:text-gray-400"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-moon size-4"><path d="M12 3a6 6 0 0 0 9 9 9 9 0 1 1-9-9Z"></path></svg></button></div></div></div></footer></div></main></div><script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"mdxSource":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n img: \"img\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n ..._provideComponents(),\n ...props.components\n }, {Accordion, AccordionGroup, CodeBlock, Frame, Heading, Note, ZoomImage} = _components;\n if (!Accordion) _missingMdxReference(\"Accordion\", true);\n if (!AccordionGroup) _missingMdxReference(\"AccordionGroup\", true);\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n if (!Frame) _missingMdxReference(\"Frame\", true);\n if (!Heading) _missingMdxReference(\"Heading\", true);\n if (!Note) _missingMdxReference(\"Note\", true);\n if (!ZoomImage) _missingMdxReference(\"ZoomImage\", true);\n return _jsxs(_Fragment, {\n children: [_jsxs(Frame, {\n children: [_jsx(ZoomImage, {\n children: _jsx(\"img\", {\n className: \"block dark:hidden\",\n src: \"https://mintlify-assets.b-cdn.net/hero-light.png\"\n })\n }), _jsx(ZoomImage, {\n children: _jsx(\"img\", {\n className: \"hidden dark:block\",\n src: \"https://mintlify-assets.b-cdn.net/hero-dark.png\"\n })\n })]\n }), \"\\n\", _jsx(Heading, {\n level: \"2\",\n id: \"getting-started\",\n children: \"Getting Started\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Welcome! Follow the instructions below to learn how to deploy, update and\\nsupercharge your documentation with Mintlify.\"\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"creating-the-repository\",\n children: \"Creating the Repository\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Mintlify docs are rendered from MDX files and configurations defined in our\\n\", _jsx(_components.a, {\n href: \"https://github.com/mintlify/starter\",\n children: \"starter kit\"\n }), \". We use GitHub to integrate\\nyour docs with your code, and make source control effortless. Onboard through the \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com\",\n children: \"dashboard\"\n }), \" or clone our \", _jsx(_components.a, {\n href: \"https://github.com/mintlify/starter\",\n children: \"starter kit\"\n }), \" to get started.\"]\n }), \"\\n\", _jsxs(AccordionGroup, {\n children: [_jsxs(Accordion, {\n icon: \"message-bot\",\n title: \"Install the GitHub app\",\n children: [_jsxs(_components.p, {\n children: [\"Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com/settings\",\n children: \"dashboard\"\n }), \", on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.\"]\n }), _jsx(Frame, {\n children: _jsx(_components.p, {\n children: _jsx(_components.img, {\n src: \"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png\",\n alt: \"GitHub Bot Verification\"\n })\n })\n })]\n }), _jsxs(Accordion, {\n icon: \"code-branch\",\n title: \"Monorepo Setup\",\n children: [_jsxs(_components.p, {\n children: [\"If you want your docs to live alongside your code as a monorepo setup, you\\ncan: 1. Move your docs content to your monorepo. 2. Specify the path to your\\n\", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" in the\\n\", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com/settings/deployment/git-settings\",\n children: \"dashboard\"\n })]\n }), _jsxs(Frame, {\n children: [_jsx(ZoomImage, {\n children: _jsx(\"img\", {\n alt: \"Monorepo setup\",\n className: \"block dark:hidden\",\n src: \"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/monorepo-light.png\"\n })\n }), _jsx(ZoomImage, {\n children: _jsx(\"img\", {\n alt: \"Monorepo setup\",\n className: \"hidden dark:block\",\n src: \"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/monorepo-dark.png\"\n })\n })]\n })]\n })]\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"updating-the-content\",\n children: \"Updating the Content\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Mintlify enables you to easily customize the style, structure, and content of\\nyour docs.\"\n }), \"\\n\", _jsxs(AccordionGroup, {\n children: [_jsxs(Accordion, {\n icon: \"rectangle-terminal\",\n title: \"Editing locally (recommended for developers)\",\n children: [_jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Install \", _jsx(_components.a, {\n href: \"https://git-scm.com/book/en/v2/Getting-Started-Installing-Git\",\n children: \"git\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Once git is installed, clone your docs repository using \", _jsx(_components.code, {\n children: \"git clone \u003cyour-repo\u003e\"\n }), \". If you haven’t set it up yet, now would be a good time to do so with these \", _jsx(_components.a, {\n href: \"https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent\",\n children: \"SSH keys\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Use your favorite IDE to open the repository.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Install our Mintlify CLI to preview changes with \", _jsx(_components.code, {\n children: \"npm i -g mintlify\"\n }), \".\"]\n }), \"\\n\"]\n }), _jsxs(_components.p, {\n children: [\"Learn more about this in our \", _jsx(_components.a, {\n href: \"/development\",\n children: \"local development guide\"\n }), \".\"]\n })]\n }), _jsx(Accordion, {\n icon: \"pen-to-square\",\n title: \"Editing with the web editor\",\n children: _jsxs(_components.p, {\n children: [\"Learn more about how to use the web editor on our \", _jsx(_components.a, {\n href: \"/web-editor\",\n children: \"guide\"\n }), \".\"]\n })\n }), _jsxs(Accordion, {\n icon: \"palette\",\n title: \"Customizing to your brand\",\n children: [_jsxs(_components.p, {\n children: [\"Easily customize colors, logos and buttons among other configurations in our \", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" file. Start with these basic configurations:\"]\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-json\",\n children: _jsxs(_components.code, {\n className: \"language-json\",\n children: [_jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"Your Company\\\"\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"logo\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token punctuation\",\n children: \"{\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"light\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"/logo/light.svg\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"dark\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"/logo/dark.svg\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"href\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"https://yourcompany.com\\\"\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token punctuation\",\n children: \"}\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"favicon\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"/favicon.svg\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"colors\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token punctuation\",\n children: \"{\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"primary\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"#2AB673\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"light\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"#55D799\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"dark\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"#117866\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token punctuation\",\n children: \"}\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.p, {\n children: [\"A full list of supported configurations can be found at \", _jsx(_components.a, {\n href: \"/settings/global\",\n children: \"global settings\"\n }), \".\"]\n })]\n }), _jsxs(Accordion, {\n icon: \"pencil\",\n title: \"Adding content\",\n children: [_jsx(_components.p, {\n children: \"Add content with simple MDX files. Initiate your pages with this template:\"\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-md\",\n children: _jsxs(_components.code, {\n className: \"language-md\",\n children: [_jsx(_components.span, {\n className: \"\",\n children: _jsx(_components.span, {\n className: \"token hr punctuation\",\n children: \"---\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: \"title: \\\"Page Title\\\"\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: \"sidebarTitle: \\\"Sidebar title (optional - if different from page title)\\\"\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: \"description: \\\"Subtitle (optional)\\\"\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: _jsx(_components.span, {\n className: \"token hr punctuation\",\n children: \"---\"\n })\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.p, {\n children: [\"Learn more about adding images, tables, lists, and more using the \", _jsx(_components.a, {\n href: \"/text\",\n children: \"MDX syntax\"\n }), \". We also offer a \", _jsx(_components.a, {\n href: \"/content/components\",\n children: \"wide array of components\"\n }), \".\"]\n })]\n }), _jsxs(Accordion, {\n icon: \"rocket\",\n title: \"Pushing changes\",\n children: [_jsxs(_components.p, {\n children: [\"Once ready, commit and push your changes to update your docs site. Here is a \", _jsx(_components.a, {\n href: \"https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push\",\n children: \"guide\"\n }), \" on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com\",\n children: \"dashboard\"\n }), \".\"]\n }), _jsx(Frame, {\n children: _jsx(_components.p, {\n children: _jsx(_components.img, {\n src: \"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png\",\n alt: \"Manual\\nUpdate\"\n })\n })\n })]\n }), _jsxs(Accordion, {\n icon: \"code-branch\",\n title: \"Generating API references\",\n children: [_jsx(_components.p, {\n children: \"You can easily set up your API references using an OpenAPI document.\"\n }), _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Add your \", _jsx(_components.code, {\n children: \"openapi.yaml\"\n }), \" or \", _jsx(_components.code, {\n children: \"openapi.json\"\n }), \" file into your docs repository or define the \", _jsx(_components.code, {\n children: \"openapi\"\n }), \" field in \", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" with a URL.\"]\n }), \"\\n\"]\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-json\",\n children: _jsxs(_components.code, {\n className: \"language-json\",\n children: [_jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"openapi\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"link-to-your-openapi-file\\\"\"\n })]\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.ol, {\n start: \"2\",\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Use our \", _jsx(_components.a, {\n href: \"/api-playground/openapi/setup#autogenerate-files-recommended\",\n children: \"scraper\"\n }), \" to autogenerate your OpenAPI endpoints files as:\"]\n }), \"\\n\"]\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-bash\",\n children: _jsxs(_components.code, {\n className: \"language-bash\",\n children: [_jsxs(_components.span, {\n className: \"\",\n children: [\"npx @mintlify/scraping@latest openapi-file \", _jsx(_components.span, {\n className: \"token operator\",\n children: \"\u003c\"\n }), \"path-or-url-to-openapi-file\", _jsx(_components.span, {\n className: \"token operator\",\n children: \"\u003e\"\n })]\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.ol, {\n start: \"3\",\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Finally, include the generated endpoint MDX files to your \", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" under \", _jsx(_components.code, {\n children: \"navigation\"\n }), \".\"]\n }), \"\\n\"]\n }), _jsxs(_components.p, {\n children: [\"For a complete guide on using Mintlify with OpenAPI, check out \", _jsx(_components.a, {\n href: \"/api-playground/openapi/setup\",\n children: \"this guide\"\n }), \". \", _jsx(_components.a, {\n href: \"/api-playground/openapi/writing-openapi\",\n children: \"This guide\"\n }), \" explains how to configure your API authentication methods. For manual API references definition, explore \", _jsx(_components.a, {\n href: \"/api-playground/overview\",\n children: \"our syntax\"\n }), \".\"]\n })]\n }), _jsxs(Accordion, {\n icon: \"chart-simple\",\n title: \"Adding analytics\",\n children: [_jsxs(_components.p, {\n children: [\"Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com/analytics\",\n children: \"dashboard\"\n }), \".\"]\n }), _jsxs(_components.p, {\n children: [\"We also support integrations with a range of analytics providers. You can find the list of providers \", _jsx(_components.a, {\n href: \"/integrations/analytics/overview\",\n children: \"here\"\n }), \".\"]\n })]\n })]\n }), \"\\n\", _jsx(Note, {\n children: _jsxs(_components.p, {\n children: [\"We provide a white-glove migration service as part of our Enterprise plan.\\nInterested? You can request it by \", _jsx(_components.a, {\n href: \"mailto:sales@mintlify.com\",\n children: \"contacting us\"\n }), \".\"]\n })\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"publishing\",\n children: \"Publishing\"\n }), \"\\n\", _jsxs(Accordion, {\n icon: \"star\",\n title: \"Adding a custom domain\",\n children: [_jsx(_components.p, {\n children: \"Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.\"\n }), _jsxs(_components.p, {\n children: [\"Navigate to your \", _jsx(_components.a, {\n href: \"https://www.dashboard.mintlify.com/settings\",\n children: \"dashboard settings\"\n }), \" to add a custom domain.\"]\n }), _jsx(Frame, {\n children: _jsx(_components.img, {\n src: \"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/custom-domain.png\",\n alt: \"Custom Domain\"\n })\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Congrats! You’ve set up your Mintlify Docs and it’s looking amazing! Need\\nsupport or want to give some feedback? You can join our\\n\", _jsx(_components.a, {\n href: \"https://mintlify.com/community\",\n children: \"community\"\n }), \" or drop us an email at\\n\", _jsx(_components.a, {\n href: \"mailto:support@mintlify.com\",\n children: \"support@mintlify.com\"\n }), \".\"]\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{"config":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Mintlify","colors":{"primary":"#0D9373","light":"#55D799","dark":"#0D9373"},"logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/dark.svg","href":"https://mintlify.com"},"favicon":"/favicon.svg","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"label":"Community","href":"https://mintlify.com/community"}],"primary":{"type":"button","label":"Get Started","href":"https://mintlify.com/start"}},"navigation":{"dropdowns":[{"dropdown":"Getting Started","icon":"book","description":"Set up your documentation","groups":[{"group":"Getting Started","pages":["quickstart",{"group":"Editing","icon":"pen-paintbrush","pages":["development","web-editor"]},"settings/global",{"group":"Navigation","icon":"map","pages":["navigation/overview","navigation/pages","navigation/divisions","navigation/versions","navigation/localization"]},"migration"]},{"group":"Writing Content","pages":["page","text","image-embeds","list-table","code","reusable-snippets"]},{"group":"API References","pages":["api-playground/overview",{"group":"OpenAPI","icon":"brackets-curly","pages":["api-playground/openapi/setup","api-playground/openapi/writing-openapi","api-playground/openapi/advanced-features"]},{"group":"MDX","icon":"markdown","pages":["api-playground/mdx/configuration","api-playground/mdx/authentication"]},"api-playground/troubleshooting"]},{"group":"Configurations","pages":["settings/custom-domain","settings/seo","settings/custom-scripts","settings/broken-links","settings/github","settings/gitlab","settings/ci","settings/preview-deployments"]},{"group":"Advanced","pages":[{"group":"Custom Subdirectory","icon":"folder","pages":["advanced/subpath/cloudflare","advanced/subpath/route53-cloudfront","advanced/subpath/vercel"]},{"group":"Auth \u0026 Personalization","icon":"user-lock","pages":["settings/authentication-personalization/authentication","settings/authentication-personalization/partial-authentication","settings/authentication-personalization/personalization","settings/authentication-personalization/authentication-vs-personalization",{"group":"Authentication Setup","pages":["settings/authentication-personalization/authentication-setup/choosing-a-handshake","settings/authentication-personalization/authentication-setup/password","settings/authentication-personalization/authentication-setup/jwt","settings/authentication-personalization/authentication-setup/oauth","settings/authentication-personalization/authentication-setup/mintlify"]},{"group":"Personalization Setup","pages":["settings/authentication-personalization/personalization-setup/choosing-a-handshake","settings/authentication-personalization/personalization-setup/shared-session","settings/authentication-personalization/personalization-setup/jwt","settings/authentication-personalization/personalization-setup/oauth"]},"settings/authentication-personalization/sending-data"]},{"group":"Dashboard Access","icon":"house-lock","pages":["advanced/dashboard/sso","advanced/dashboard/permissions"]},{"group":"REST API","icon":"brackets-curly","pages":["advanced/rest-api/overview",{"group":"Updates","pages":["advanced/rest-api/update/trigger","advanced/rest-api/update/status"]},{"group":"Chat API","pages":["advanced/rest-api/chat/create-topic","advanced/rest-api/chat/generate-message"]}]}]}]},{"dropdown":"Components","icon":"block-brick","description":"Component library","groups":[{"group":"Components","pages":["content/components/accordions","content/components/accordion-groups","content/components/callouts","content/components/cards","content/components/card-groups","content/components/code","content/components/code-groups","content/components/frames","content/components/icons","content/components/mermaid-diagrams","content/components/steps","content/components/tabs","content/components/tooltips","content/components/update"]},{"group":"API Components","pages":["content/components/params","content/components/responses","content/components/expandables","content/components/sticky-examples"]}]},{"dropdown":"Integrations","icon":"plug","description":"Connect your providers","groups":[{"group":"Analytics","pages":["integrations/analytics/overview","integrations/analytics/amplitude","integrations/analytics/clearbit","integrations/analytics/fathom","integrations/analytics/google-analytics","integrations/analytics/google-tag-manager","integrations/analytics/heap","integrations/analytics/hotjar","integrations/analytics/koala","integrations/analytics/logrocket","integrations/analytics/mixpanel","integrations/analytics/pirsch","integrations/analytics/plausible","integrations/analytics/posthog","integrations/analytics/segment"]},{"group":"SDKs","pages":["integrations/sdks/speakeasy","integrations/sdks/stainless"]},{"group":"Support","pages":["integrations/support/overview","integrations/support/intercom","integrations/support/front"]},{"group":"Privacy","pages":["integrations/privacy/overview","integrations/privacy/osano"]}]},{"dropdown":"Changelog","icon":"list-timeline","description":"Updates and changes","groups":[{"group":"Changelog","pages":["changelog/overview"]}]}]},"footer":{"socials":{"x":"https://x.com/mintlify","linkedin":"https://www.linkedin.com/company/mintlify","github":"https://github.com/mintlify","slack":"https://mintlify.com/community"},"links":[{"header":"Resources","items":[{"label":"Customers","href":"https://mintlify.com/customers"},{"label":"Enterprise","href":"https://mintlify.com/enterprise"},{"label":"Request Preview","href":"https://mintlify.com/preview"},{"label":"Integrations","href":"https://mintlify.com/docs/integrations/analytics/overview"},{"label":"Templates","href":"https://github.com/mintlify/themes"},{"label":"Wall of Love","href":"https://mintlify.com/love"}]},{"header":"Company","items":[{"label":"Careers","href":"https://mintlify.com/careers"},{"label":"Blog","href":"https://mintlify.com/blog"},{"label":"Public Roadmap","href":"https://feedback.mintlify.com/roadmap"},{"label":"Security","href":"https://mintlify.com/security/responsible-disclosure"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://mintlify.com/legal/privacy"},{"label":"Terms of Service","href":"https://mintlify.com/legal/terms"}]}]},"integrations":{"ga4":{"measurementId":"G-RCYWHL7EQ7"},"koala":{"publicApiKey":"pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"}}},"pageMetadata":{"title":"Quickstart","description":"Start building modern documentation in under five minutes","icon":"rocket","href":"/quickstart"}}},"mdxExtracts":{"tableOfContents":[{"title":"Getting Started","slug":"getting-started","depth":2,"children":[{"title":"Creating the Repository","slug":"creating-the-repository","depth":3,"children":[]},{"title":"Updating the Content","slug":"updating-the-content","depth":3,"children":[]},{"title":"Publishing","slug":"publishing","depth":3,"children":[]}]}],"codeExamples":{}},"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: \"Start building modern documentation in under five minutes\"\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":{}},"pageData":{"navWithMetadata":[{"group":"Getting Started","pages":[{"title":"Quickstart","description":"Start building modern documentation in under five minutes","icon":"rocket","href":"/quickstart"},{"group":"Editing","icon":"pen-paintbrush","pages":[{"title":"Local Development","description":"Preview changes locally to update your docs","href":"/development"},{"title":"Web Editor","description":"Edit your docs directly from the dashboard with live previews.","href":"/web-editor"}]},{"title":"Global Settings","description":"Configure your documentation using the `docs.json` file","icon":"wrench","href":"/settings/global"},{"title":"Navigation","description":"Organize your docs directory to guide your users to the information they need ","icon":"map","href":"/settings/navigation"},{"title":"Migration","description":"How to migrate documentation from your existing provider","icon":"arrow-up-from-bracket","href":"/migration"}]},{"group":"Writing Content","pages":[{"title":"Page Titles and Metadata","description":"Setting the title and metadata for navigation and SEO","icon":"text-size","href":"/page"},{"title":"Headers and Text","description":"Text, title, and styling in standard markdown","icon":"heading","href":"/text"},{"title":"Images, Videos, and Embeds","description":"Add image, video, and other HTML elements","icon":"image","href":"/image-embeds"},{"title":"Lists and Tables","description":"Display information in lists and tables","icon":"list","href":"/list-table"},{"title":"Code Blocks","description":"Display inline code and code blocks","icon":"code","href":"/code"},{"title":"Reusable Snippets","description":"Reusable, custom snippets to keep content in sync","icon":"recycle","href":"/reusable-snippets"}]},{"group":"API References","pages":[{"title":"Interactive Playground","description":"Enable users to interact with your API","openapi":"GET /plants/{id}","hideApiMarker":true,"icon":"play","href":"/api-playground/overview"},{"group":"OpenAPI","icon":"brackets-curly","pages":[{"title":"OpenAPI Setup","description":"Reference OpenAPI endpoints in your docs pages","href":"/api-playground/openapi/setup"},{"title":"Writing OpenAPI","description":"Use OpenAPI features to enhance your Mintlify docs","href":"/api-playground/openapi/writing-openapi"},{"title":"Advanced Features","description":"Support for advanced OpenAPI features","href":"/api-playground/openapi/advanced-features"}]},{"group":"MDX","icon":"markdown","pages":[{"title":"MDX Setup","description":"Generate docs pages for your API endpoints using MDX","href":"/api-playground/mdx/configuration"},{"title":"Authentication","description":"You can set authentication parameters to let users use their real API keys.","href":"/api-playground/mdx/authentication"}]},{"title":"Troubleshooting","description":"Common issues with API References","icon":"triangle-exclamation","href":"/api-playground/troubleshooting"}]},{"group":"Configurations","pages":[{"title":"Custom Domain","description":"Host your documentation at your website's custom domain","icon":"globe","href":"/settings/custom-domain"},{"title":"SEO","description":"Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in mint.json or change them per page.","icon":"magnifying-glass","href":"/settings/seo"},{"title":"Redirects and Broken Links","description":"Tools to help prevent invalid links","icon":"link-simple","href":"/settings/broken-links"},{"title":"Versioning \u0026 Localization","description":"Build separate versions or localizations","icon":"square-chevron-down","href":"/settings/versioning"},{"title":"Editor Permissions","description":"Allow more members of your team to update your docs","icon":"user-group-simple","href":"/settings/add-members"},{"title":"GitHub","description":"Sync your docs with a GitHub repo","icon":"github","href":"/settings/github"},{"title":"GitLab","description":"Sync your docs with a GitLab repo","icon":"gitlab","href":"/settings/gitlab"},{"title":"Preview Deployments","description":"Preview changes to your docs in a live deployment","icon":"street-view","href":"/settings/preview-deployments"}]},{"group":"Advanced","pages":[{"group":"Custom Scripts","icon":"code","pages":[{"title":"Custom CSS","description":"Fully customize your documentation with custom CSS","href":"/advanced/custom/css"},{"title":"Custom JS","description":"Add JavaScript functionality globally","href":"/advanced/custom/js"}]},{"group":"Custom Subdirectory","icon":"folder","pages":[{"title":"Cloudflare","description":"Host documentation at a /docs subpath using Cloudflare Workers","href":"/advanced/subpath/cloudflare"},{"title":"AWS Route 53 and Cloudfront","description":"Host documentation at a /docs subdirectory using AWS services","sidebarTitle":"AWS","href":"/advanced/subpath/route53-cloudfront"},{"title":"Vercel","description":"Host documentation at a /docs subpath using Vercel","href":"/advanced/subpath/vercel"}]},{"group":"Auth \u0026 Personalization","icon":"user-lock","pages":[{"title":"Authentication","description":"Guarantee privacy of your docs by authenticating users","href":"/settings/authentication-personalization/authentication"},{"title":"Partial Authentication","description":"Authenticate users to view only certain pages","href":"/settings/authentication-personalization/partial-authentication"},{"title":"Personalization","description":"A list of features unlocked with Personalization","href":"/settings/authentication-personalization/personalization"},{"title":"Auth vs Personalization","description":"How to determine which product is best for you","href":"/settings/authentication-personalization/authentication-vs-personalization"},{"group":"Authentication Setup","pages":[{"title":"Choosing a Handshake","description":"How to decide which Handshake method is right for your docs","href":"/settings/authentication-personalization/authentication-setup/choosing-a-handshake"},{"title":"Password Handshake","description":"Use a set of shared passwords to authenticate users","href":"/settings/authentication-personalization/authentication-setup/password"},{"title":"JWT Handshake","description":"Use a customized login flow to authenticate users","href":"/settings/authentication-personalization/authentication-setup/jwt"},{"title":"OAuth 2.0 Handshake","description":"Integrate with your OAuth server to enable user login via the Authorization Code flow","href":"/settings/authentication-personalization/authentication-setup/oauth"},{"title":"Mintlify Auth Handshake","description":"Use Mintlify to authenticate users","href":"/settings/authentication-personalization/authentication-setup/mintlify"}]},{"group":"Personalization Setup","pages":[{"title":"Choosing a Handshake","description":"How to decide which Handshake method is right for your docs","href":"/settings/authentication-personalization/personalization-setup/choosing-a-handshake"},{"title":"Shared Session Handshake","description":"Seamlessly share user sessions between your dashboard and your docs","href":"/settings/authentication-personalization/personalization-setup/shared-session"},{"title":"JWT Handshake","description":"Use a customized login flow to authenticate users","href":"/settings/authentication-personalization/personalization-setup/jwt"},{"title":"OAuth 2.0 Handshake","description":"Integrate with your OAuth server to enable user login via the PKCE flow","href":"/settings/authentication-personalization/personalization-setup/oauth"}]},{"title":"Sending Data","description":"The shape of user data you can use to personalize your docs","href":"/settings/authentication-personalization/sending-data"}]},{"group":"Extensions","icon":"plug","pages":[{"title":"Chat Widget","description":"Integrate the Mintlify widget into your products to offer users quick access to AI-powered chat with your docs content as the knowledge base.","href":"/advanced/widget/chat"}]},{"group":"REST API","icon":"brackets-curly","pages":[{"title":"Overview","description":null,"href":"/advanced/rest-api/overview"},{"group":"Updates","pages":[{"title":"Trigger an update","description":"Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check.","openapi":"POST /project/update/{projectId}","href":"/advanced/rest-api/update/trigger"},{"title":"Get the status of an update","description":null,"openapi":"GET /project/update-status/{statusId}","href":"/advanced/rest-api/update/status"}]},{"group":"Chat API","pages":[{"title":"Create a chat topic","description":"Creates a topic to manage message history for a given AI chat conversation.","openapi":"POST /chat/topic","href":"/advanced/rest-api/chat/create-topic"},{"title":"Generate a message completion","description":"Generate a completion in response to a user query","openapi":"POST /chat/message","href":"/advanced/rest-api/chat/generate-message"}]}]}]},{"group":"Analytics","pages":[{"title":"Analytics Integrations","description":"Integrate with an analytics platform to track events","href":"/integrations/analytics/overview"},{"title":"Amplitude","description":null,"href":"/integrations/analytics/amplitude"},{"title":"Clearbit","description":null,"href":"/integrations/analytics/clearbit"},{"title":"Fathom","description":null,"href":"/integrations/analytics/fathom"},{"title":"Google Analytics 4","description":null,"href":"/integrations/analytics/google-analytics"},{"title":"Google Tag Manager","description":null,"href":"/integrations/analytics/google-tag-manager"},{"title":"Heap","description":null,"href":"/integrations/analytics/heap"},{"title":"HotJar","description":null,"href":"/integrations/analytics/hotjar"},{"title":"Koala","description":null,"href":"/integrations/analytics/koala"},{"title":"LogRocket","description":null,"href":"/integrations/analytics/logrocket"},{"title":"Mixpanel","description":null,"href":"/integrations/analytics/mixpanel"},{"title":"Pirsch","description":null,"href":"/integrations/analytics/pirsch"},{"title":"Plausible","description":null,"href":"/integrations/analytics/plausible"},{"title":"PostHog","description":null,"href":"/integrations/analytics/posthog"}]},{"group":"SDKs","pages":[{"title":"Speakeasy","description":"Automate your SDK usage snippets in the API playground","href":"/integrations/sdks/speakeasy"},{"title":"Stainless","description":"Automate your SDK example snippets in the API playground","href":"/integrations/sdks/stainless"}]},{"group":"Support","pages":[{"title":"Support Integrations","description":"Integrate with a support widget","href":"/integrations/support/overview"},{"title":"Intercom","description":null,"href":"/integrations/support/intercom"},{"title":"Front","description":null,"href":"/integrations/support/front"}]},{"group":"Privacy","pages":[{"title":"Privacy Integrations","description":"Integrate with a data privacy platform","href":"/integrations/privacy/overview"},{"title":"Osano","description":null,"href":"/integrations/privacy/osano"}]},{"group":"Components","pages":[{"title":"Accordions","description":"A dropdown component to toggle content","icon":"square-caret-down","href":"/content/components/accordions"},{"title":"Accordion Groups","description":"Group multiple accordions into a single display.","icon":"table-rows","href":"/content/components/accordion-groups"},{"title":"Callout Boxes","description":"Use callouts to add eye-catching context to your content","icon":"circle-exclamation","href":"/content/components/callouts"},{"title":"Cards","description":"Highlight main points or links with customizable icons","icon":"rectangle","href":"/content/components/cards"},{"title":"Card Groups","description":"Show cards side by side in a grid format","icon":"rectangles-mixed","href":"/content/components/card-groups"},{"title":"Code Blocks","description":"Display code with optional syntax highlighting","icon":"code","href":"/content/components/code"},{"title":"Code Groups","description":"The CodeGroup component lets you combine code blocks in a display separated by tabs","icon":"rectangle-code","href":"/content/components/code-groups"},{"title":"Frames","description":"Use the Frame component to wrap images or other components in a container.","icon":"frame","href":"/content/components/frames"},{"title":"Icons","description":"Use [Font Awesome](https://fontawesome.com/icons) icons anywhere in the doc","icon":"icons","href":"/content/components/icons"},{"title":"Mermaid Diagrams","description":"Display diagrams using Mermaid","icon":"diagram-project","href":"/content/components/mermaid-diagrams"},{"title":"Steps","description":"Sequence content using the Steps component","icon":"arrow-progress","href":"/content/components/steps"},{"title":"Tabs","description":"Toggle content using the Tabs component","icon":"window-restore","href":"/content/components/tabs"},{"title":"Tooltips","description":"Show a definition when you hover over text.","icon":"message-lines","href":"/content/components/tooltips"},{"title":"Update","description":"Keep track of changes and updates","icon":"rectangle-history","href":"/content/components/update"}]},{"group":"API Components","pages":[{"title":"Parameter Fields","description":"Set path, query, and body parameters","icon":"text-size","href":"/content/components/params"},{"title":"Response Fields","description":"Display API response values","icon":"message","href":"/content/components/responses"},{"title":"Expandables","description":"Toggle to display nested properties.","icon":"caret-down","href":"/content/components/expandables"},{"title":"Sidebar Code Examples","description":"Display code blocks at the top-right of the page on desktop devices","icon":"sidebar-flip","href":"/content/components/sticky-examples"}]},{"group":"Changelog","pages":[{"title":"Product Updates","description":"New updates and improvements","mode":"center","href":"/changelog/overview"}]}],"docsNavWithMetadata":{"global":null,"dropdowns":[{"dropdown":"Getting Started","icon":"book","description":"Set up your documentation","groups":[{"group":"Getting Started","pages":[{"title":"Quickstart","description":"Start building modern documentation in under five minutes","icon":"rocket","href":"/quickstart"},{"group":"Editing","icon":"pen-paintbrush","pages":[{"title":"Local Development","description":"Preview changes locally to update your docs","href":"/development"},{"title":"Web Editor","description":"Edit your docs directly from the dashboard with live previews.","href":"/web-editor"}]},{"title":"Global Settings","description":"Configure your documentation using the `docs.json` file","icon":"wrench","href":"/settings/global"},{"group":"Navigation","icon":"map","pages":[{"title":"Overview","description":"The `navigation` property controls the hierarchy of your documentation.","href":"/navigation/overview"},{"title":"Pages and Groups","description":null,"href":"/navigation/pages"},{"title":"Tabs, Anchors, Dropdowns","description":null,"href":"/navigation/divisions"},{"title":"Versions","description":null,"href":"/navigation/versions"},{"title":"Localization","description":null,"href":"/navigation/localization"}]},{"title":"Migration","description":"How to migrate documentation from your existing provider","icon":"arrow-up-from-bracket","href":"/migration"}]},{"group":"Writing Content","pages":[{"title":"Page Titles and Metadata","description":"Setting the title and metadata for navigation and SEO","icon":"text-size","href":"/page"},{"title":"Headers and Text","description":"Text, title, and styling in standard markdown","icon":"heading","href":"/text"},{"title":"Images, Videos, and Embeds","description":"Add image, video, and other HTML elements","icon":"image","href":"/image-embeds"},{"title":"Lists and Tables","description":"Display information in lists and tables","icon":"list","href":"/list-table"},{"title":"Code Blocks","description":"Display inline code and code blocks","icon":"code","href":"/code"},{"title":"Reusable Snippets","description":"Reusable, custom snippets to keep content in sync","icon":"recycle","href":"/reusable-snippets"}]},{"group":"API References","pages":[{"title":"Playground","description":"Enable users to interact with your API","openapi":"GET /plants/{id}","hideApiMarker":true,"icon":"play","href":"/api-playground/overview"},{"group":"OpenAPI","icon":"brackets-curly","pages":[{"title":"OpenAPI Setup","description":"Reference OpenAPI endpoints in your docs pages","href":"/api-playground/openapi/setup"},{"title":"Writing OpenAPI","description":"Use OpenAPI features to enhance your Mintlify docs","href":"/api-playground/openapi/writing-openapi"},{"title":"Advanced Features","description":"Support for advanced OpenAPI features","href":"/api-playground/openapi/advanced-features"}]},{"group":"MDX","icon":"markdown","pages":[{"title":"MDX Setup","description":"Generate docs pages for your API endpoints using MDX","href":"/api-playground/mdx/configuration"},{"title":"Authentication","description":"You can set authentication parameters to let users use their real API keys.","href":"/api-playground/mdx/authentication"}]},{"title":"Troubleshooting","description":"Common issues with API References","icon":"triangle-exclamation","href":"/api-playground/troubleshooting"}]},{"group":"Configurations","pages":[{"title":"Custom Domain","description":"Host your documentation at your website's custom domain","icon":"globe","href":"/settings/custom-domain"},{"title":"SEO","description":"Mintlify automatically generates most meta tags. If you want to customize them, you can set default values in docs.json or change them per page.","icon":"magnifying-glass","href":"/settings/seo"},{"title":"Custom CSS \u0026 JS","description":"Fully customize your documentation with custom CSS \u0026 JS","icon":"code","href":"/settings/custom-scripts"},{"title":"Redirects and Broken Links","description":"Tools to help prevent invalid links","icon":"link-simple","href":"/settings/broken-links"},{"title":"GitHub","description":"Sync your docs with a GitHub repo","icon":"github","href":"/settings/github"},{"title":"GitLab","description":"Sync your docs with a GitLab repo","icon":"gitlab","href":"/settings/gitlab"},{"title":"CI Checks","description":"Add broken links, linting, and grammar checks to the updating process","icon":"circle-check","href":"/settings/ci"},{"title":"Preview Deployments","description":"Preview changes to your docs in a live deployment","icon":"street-view","href":"/settings/preview-deployments"}]},{"group":"Advanced","pages":[{"group":"Custom Subdirectory","icon":"folder","pages":[{"title":"Cloudflare","description":"Host documentation at a /docs subpath using Cloudflare Workers","href":"/advanced/subpath/cloudflare"},{"title":"AWS Route 53 and Cloudfront","description":"Host documentation at a /docs subdirectory using AWS services","sidebarTitle":"AWS","href":"/advanced/subpath/route53-cloudfront"},{"title":"Vercel","description":"Host documentation at a /docs subpath using Vercel","href":"/advanced/subpath/vercel"}]},{"group":"Auth \u0026 Personalization","icon":"user-lock","pages":[{"title":"Authentication","description":"Guarantee privacy of your docs by authenticating users","href":"/settings/authentication-personalization/authentication"},{"title":"Partial Authentication","description":"Authenticate users to view only certain pages","href":"/settings/authentication-personalization/partial-authentication"},{"title":"Personalization","description":"A list of features unlocked with Personalization","href":"/settings/authentication-personalization/personalization"},{"title":"Auth vs Personalization","description":"How to determine which product is best for you","href":"/settings/authentication-personalization/authentication-vs-personalization"},{"group":"Authentication Setup","pages":[{"title":"Choosing a Handshake","description":"How to decide which Handshake method is right for your docs","href":"/settings/authentication-personalization/authentication-setup/choosing-a-handshake"},{"title":"Password Handshake","description":"Use a set of shared passwords to authenticate users","href":"/settings/authentication-personalization/authentication-setup/password"},{"title":"JWT Handshake","description":"Use a customized login flow to authenticate users","href":"/settings/authentication-personalization/authentication-setup/jwt"},{"title":"OAuth 2.0 Handshake","description":"Integrate with your OAuth server to enable user login via the Authorization Code flow","href":"/settings/authentication-personalization/authentication-setup/oauth"},{"title":"Mintlify Auth Handshake","description":"Use Mintlify to authenticate users","href":"/settings/authentication-personalization/authentication-setup/mintlify"}]},{"group":"Personalization Setup","pages":[{"title":"Choosing a Handshake","description":"How to decide which Handshake method is right for your docs","href":"/settings/authentication-personalization/personalization-setup/choosing-a-handshake"},{"title":"Shared Session Handshake","description":"Seamlessly share user sessions between your dashboard and your docs","href":"/settings/authentication-personalization/personalization-setup/shared-session"},{"title":"JWT Handshake","description":"Use a customized login flow to authenticate users","href":"/settings/authentication-personalization/personalization-setup/jwt"},{"title":"OAuth 2.0 Handshake","description":"Integrate with your OAuth server to enable user login via the PKCE flow","href":"/settings/authentication-personalization/personalization-setup/oauth"}]},{"title":"Sending Data","description":"The shape of user data you can use to personalize your docs","href":"/settings/authentication-personalization/sending-data"}]},{"group":"Dashboard Access","icon":"house-lock","pages":[{"title":"Single Sign-On (SSO)","description":"Customize how your team can login to your admin dashboard","href":"/advanced/dashboard/sso"},{"title":"Editor Permissions","description":"Allow more members of your team to update your docs","href":"/advanced/dashboard/permissions"}]},{"group":"REST API","icon":"brackets-curly","pages":[{"title":"Overview","description":null,"href":"/advanced/rest-api/overview"},{"group":"Updates","pages":[{"title":"Trigger an update","description":"Trigger an update after updating your OpenAPI document by calling this endpoint in a CI check.","openapi":"POST /project/update/{projectId}","href":"/advanced/rest-api/update/trigger"},{"title":"Get the status of an update","description":null,"openapi":"GET /project/update-status/{statusId}","href":"/advanced/rest-api/update/status"}]},{"group":"Chat API","pages":[{"title":"Create a chat topic","description":"Creates a topic to manage message history for a given AI chat conversation.","openapi":"POST /chat/topic","href":"/advanced/rest-api/chat/create-topic"},{"title":"Generate a message completion","description":"Generate a completion in response to a user query","openapi":"POST /chat/message","href":"/advanced/rest-api/chat/generate-message"}]}]}]}]},{"dropdown":"Components","icon":"block-brick","description":"Component library","groups":[{"group":"Components","pages":[{"title":"Accordions","description":"A dropdown component to toggle content","icon":"square-caret-down","href":"/content/components/accordions"},{"title":"Accordion Groups","description":"Group multiple accordions into a single display.","icon":"table-rows","href":"/content/components/accordion-groups"},{"title":"Callout Boxes","description":"Use callouts to add eye-catching context to your content","icon":"circle-exclamation","href":"/content/components/callouts"},{"title":"Cards","description":"Highlight main points or links with customizable icons","icon":"rectangle","href":"/content/components/cards"},{"title":"Card Groups","description":"Show cards side by side in a grid format","icon":"rectangles-mixed","href":"/content/components/card-groups"},{"title":"Code Blocks","description":"Display code with optional syntax highlighting","icon":"code","href":"/content/components/code"},{"title":"Code Groups","description":"The CodeGroup component lets you combine code blocks in a display separated by tabs","icon":"rectangle-code","href":"/content/components/code-groups"},{"title":"Frames","description":"Use the Frame component to wrap images or other components in a container.","icon":"frame","href":"/content/components/frames"},{"title":"Icons","description":"Use [Font Awesome](https://fontawesome.com/icons) icons anywhere in the doc","icon":"icons","href":"/content/components/icons"},{"title":"Mermaid Diagrams","description":"Display diagrams using Mermaid","icon":"diagram-project","href":"/content/components/mermaid-diagrams"},{"title":"Steps","description":"Sequence content using the Steps component","icon":"arrow-progress","href":"/content/components/steps"},{"title":"Tabs","description":"Toggle content using the Tabs component","icon":"window-restore","href":"/content/components/tabs"},{"title":"Tooltips","description":"Show a definition when you hover over text.","icon":"message-lines","href":"/content/components/tooltips"},{"title":"Update","description":"Keep track of changes and updates","icon":"rectangle-history","href":"/content/components/update"}]},{"group":"API Components","pages":[{"title":"Parameter Fields","description":"Set path, query, and body parameters","icon":"text-size","href":"/content/components/params"},{"title":"Response Fields","description":"Display API response values","icon":"message","href":"/content/components/responses"},{"title":"Expandables","description":"Toggle to display nested properties.","icon":"caret-down","href":"/content/components/expandables"},{"title":"Sidebar Code Examples","description":"Display code blocks at the top-right of the page on desktop devices","icon":"sidebar-flip","href":"/content/components/sticky-examples"}]}]},{"dropdown":"Integrations","icon":"plug","description":"Connect your providers","groups":[{"group":"Analytics","pages":[{"title":"Analytics Integrations","description":"Integrate with an analytics platform to track events","href":"/integrations/analytics/overview"},{"title":"Amplitude","description":null,"href":"/integrations/analytics/amplitude"},{"title":"Clearbit","description":null,"href":"/integrations/analytics/clearbit"},{"title":"Fathom","description":null,"href":"/integrations/analytics/fathom"},{"title":"Google Analytics 4","description":null,"href":"/integrations/analytics/google-analytics"},{"title":"Google Tag Manager","description":null,"href":"/integrations/analytics/google-tag-manager"},{"title":"Heap","description":null,"href":"/integrations/analytics/heap"},{"title":"HotJar","description":null,"href":"/integrations/analytics/hotjar"},{"title":"Koala","description":null,"href":"/integrations/analytics/koala"},{"title":"LogRocket","description":null,"href":"/integrations/analytics/logrocket"},{"title":"Mixpanel","description":null,"href":"/integrations/analytics/mixpanel"},{"title":"Pirsch","description":null,"href":"/integrations/analytics/pirsch"},{"title":"Plausible","description":null,"href":"/integrations/analytics/plausible"},{"title":"PostHog","description":null,"href":"/integrations/analytics/posthog"},{"title":"Segment","description":null,"href":"/integrations/analytics/segment"}]},{"group":"SDKs","pages":[{"title":"Speakeasy","description":"Automate your SDK usage snippets in the API playground","href":"/integrations/sdks/speakeasy"},{"title":"Stainless","description":"Automate your SDK example snippets in the API playground","href":"/integrations/sdks/stainless"}]},{"group":"Support","pages":[{"title":"Support Integrations","description":"Integrate with a support widget","href":"/integrations/support/overview"},{"title":"Intercom","description":null,"href":"/integrations/support/intercom"},{"title":"Front","description":null,"href":"/integrations/support/front"}]},{"group":"Privacy","pages":[{"title":"Privacy Integrations","description":"Integrate with a data privacy platform","href":"/integrations/privacy/overview"},{"title":"Osano","description":null,"href":"/integrations/privacy/osano"}]}]},{"dropdown":"Changelog","icon":"list-timeline","description":"Updates and changes","groups":[{"group":"Changelog","pages":[{"title":"Product Updates","description":"New updates and improvements","mode":"center","href":"/changelog/overview"}]}]}]},"pageMetadata":{"title":"Quickstart","description":"Start building modern documentation in under five minutes","icon":"rocket","href":"/quickstart"},"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Mintlify","colors":{"primary":"#0D9373","light":"#55D799","dark":"#0D9373"},"logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/dark.svg","href":"https://mintlify.com"},"favicon":"/favicon.svg","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"label":"Community","href":"https://mintlify.com/community"}],"primary":{"type":"button","label":"Get Started","href":"https://mintlify.com/start"}},"navigation":{"dropdowns":[{"dropdown":"Getting Started","icon":"book","description":"Set up your documentation","groups":[{"group":"Getting Started","pages":["quickstart",{"group":"Editing","icon":"pen-paintbrush","pages":["development","web-editor"]},"settings/global",{"group":"Navigation","icon":"map","pages":["navigation/overview","navigation/pages","navigation/divisions","navigation/versions","navigation/localization"]},"migration"]},{"group":"Writing Content","pages":["page","text","image-embeds","list-table","code","reusable-snippets"]},{"group":"API References","pages":["api-playground/overview",{"group":"OpenAPI","icon":"brackets-curly","pages":["api-playground/openapi/setup","api-playground/openapi/writing-openapi","api-playground/openapi/advanced-features"]},{"group":"MDX","icon":"markdown","pages":["api-playground/mdx/configuration","api-playground/mdx/authentication"]},"api-playground/troubleshooting"]},{"group":"Configurations","pages":["settings/custom-domain","settings/seo","settings/custom-scripts","settings/broken-links","settings/github","settings/gitlab","settings/ci","settings/preview-deployments"]},{"group":"Advanced","pages":[{"group":"Custom Subdirectory","icon":"folder","pages":["advanced/subpath/cloudflare","advanced/subpath/route53-cloudfront","advanced/subpath/vercel"]},{"group":"Auth \u0026 Personalization","icon":"user-lock","pages":["settings/authentication-personalization/authentication","settings/authentication-personalization/partial-authentication","settings/authentication-personalization/personalization","settings/authentication-personalization/authentication-vs-personalization",{"group":"Authentication Setup","pages":["settings/authentication-personalization/authentication-setup/choosing-a-handshake","settings/authentication-personalization/authentication-setup/password","settings/authentication-personalization/authentication-setup/jwt","settings/authentication-personalization/authentication-setup/oauth","settings/authentication-personalization/authentication-setup/mintlify"]},{"group":"Personalization Setup","pages":["settings/authentication-personalization/personalization-setup/choosing-a-handshake","settings/authentication-personalization/personalization-setup/shared-session","settings/authentication-personalization/personalization-setup/jwt","settings/authentication-personalization/personalization-setup/oauth"]},"settings/authentication-personalization/sending-data"]},{"group":"Dashboard Access","icon":"house-lock","pages":["advanced/dashboard/sso","advanced/dashboard/permissions"]},{"group":"REST API","icon":"brackets-curly","pages":["advanced/rest-api/overview",{"group":"Updates","pages":["advanced/rest-api/update/trigger","advanced/rest-api/update/status"]},{"group":"Chat API","pages":["advanced/rest-api/chat/create-topic","advanced/rest-api/chat/generate-message"]}]}]}]},{"dropdown":"Components","icon":"block-brick","description":"Component library","groups":[{"group":"Components","pages":["content/components/accordions","content/components/accordion-groups","content/components/callouts","content/components/cards","content/components/card-groups","content/components/code","content/components/code-groups","content/components/frames","content/components/icons","content/components/mermaid-diagrams","content/components/steps","content/components/tabs","content/components/tooltips","content/components/update"]},{"group":"API Components","pages":["content/components/params","content/components/responses","content/components/expandables","content/components/sticky-examples"]}]},{"dropdown":"Integrations","icon":"plug","description":"Connect your providers","groups":[{"group":"Analytics","pages":["integrations/analytics/overview","integrations/analytics/amplitude","integrations/analytics/clearbit","integrations/analytics/fathom","integrations/analytics/google-analytics","integrations/analytics/google-tag-manager","integrations/analytics/heap","integrations/analytics/hotjar","integrations/analytics/koala","integrations/analytics/logrocket","integrations/analytics/mixpanel","integrations/analytics/pirsch","integrations/analytics/plausible","integrations/analytics/posthog","integrations/analytics/segment"]},{"group":"SDKs","pages":["integrations/sdks/speakeasy","integrations/sdks/stainless"]},{"group":"Support","pages":["integrations/support/overview","integrations/support/intercom","integrations/support/front"]},{"group":"Privacy","pages":["integrations/privacy/overview","integrations/privacy/osano"]}]},{"dropdown":"Changelog","icon":"list-timeline","description":"Updates and changes","groups":[{"group":"Changelog","pages":["changelog/overview"]}]}]},"footer":{"socials":{"x":"https://x.com/mintlify","linkedin":"https://www.linkedin.com/company/mintlify","github":"https://github.com/mintlify","slack":"https://mintlify.com/community"},"links":[{"header":"Resources","items":[{"label":"Customers","href":"https://mintlify.com/customers"},{"label":"Enterprise","href":"https://mintlify.com/enterprise"},{"label":"Request Preview","href":"https://mintlify.com/preview"},{"label":"Integrations","href":"https://mintlify.com/docs/integrations/analytics/overview"},{"label":"Templates","href":"https://github.com/mintlify/themes"},{"label":"Wall of Love","href":"https://mintlify.com/love"}]},{"header":"Company","items":[{"label":"Careers","href":"https://mintlify.com/careers"},{"label":"Blog","href":"https://mintlify.com/blog"},{"label":"Public Roadmap","href":"https://feedback.mintlify.com/roadmap"},{"label":"Security","href":"https://mintlify.com/security/responsible-disclosure"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://mintlify.com/legal/privacy"},{"label":"Terms of Service","href":"https://mintlify.com/legal/terms"}]}]},"integrations":{"ga4":{"measurementId":"G-RCYWHL7EQ7"},"koala":{"publicApiKey":"pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"}}},"apiReferenceData":{}},"feedback":{"thumbs":true,"edits":true},"favicons":{"icons":[{"rel":"apple-touch-icon","sizes":"180x180","href":"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/apple-touch-icon.png?v=3","type":"image/png"},{"rel":"icon","sizes":"32x32","href":"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/favicon-32x32.png?v=3","type":"image/png"},{"rel":"icon","sizes":"16x16","href":"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/favicon-16x16.png?v=3","type":"image/png"},{"rel":"shortcut icon","href":"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/favicon.ico?v=3","type":"image/x-icon"}],"browserconfig":"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/_generated/favicon/browserconfig.xml?v=3"},"subdomain":"mintlify","actualSubdomain":"mintlify","internalAnalyticsWriteKey":"phc_TXdpocbGVeZVm5VJmAsHTMrCofBQu3e0kN8HGMNGTVW","inkeep":{"integrationApiKey":"d162892454af65de7076c7f69716ba12838dacfcd47d2bae"},"trieve":{"chatEnabled":true,"datasetId":"30e749f4-370d-47e9-bb15-5de369d58348"},"userAuth":{"apiUrl":"https://dashboard.mintlify.com/api/docs/user-info","loginUrl":"https://dashboard.mintlify.com/login","type":"shared-session","invalidatedAt":1736958112096},"shouldIndex":true,"org":{"plan":"enterprise"},"cssFiles":[],"jsFiles":[],"mdxSourceWithNoJs":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n img: \"img\",\n li: \"li\",\n ol: \"ol\",\n p: \"p\",\n pre: \"pre\",\n span: \"span\",\n ..._provideComponents(),\n ...props.components\n }, {Accordion, AccordionGroup, CodeBlock, Frame, Heading, Note, ZoomImage} = _components;\n if (!Accordion) _missingMdxReference(\"Accordion\", true);\n if (!AccordionGroup) _missingMdxReference(\"AccordionGroup\", true);\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n if (!Frame) _missingMdxReference(\"Frame\", true);\n if (!Heading) _missingMdxReference(\"Heading\", true);\n if (!Note) _missingMdxReference(\"Note\", true);\n if (!ZoomImage) _missingMdxReference(\"ZoomImage\", true);\n return _jsxs(_Fragment, {\n children: [_jsxs(Frame, {\n children: [_jsx(ZoomImage, {\n children: _jsx(\"img\", {\n className: \"block dark:hidden\",\n src: \"https://mintlify-assets.b-cdn.net/hero-light.png\"\n })\n }), _jsx(ZoomImage, {\n children: _jsx(\"img\", {\n className: \"hidden dark:block\",\n src: \"https://mintlify-assets.b-cdn.net/hero-dark.png\"\n })\n })]\n }), \"\\n\", _jsx(Heading, {\n level: \"2\",\n id: \"getting-started\",\n children: \"Getting Started\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Welcome! Follow the instructions below to learn how to deploy, update and\\nsupercharge your documentation with Mintlify.\"\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"creating-the-repository\",\n children: \"Creating the Repository\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Mintlify docs are rendered from MDX files and configurations defined in our\\n\", _jsx(_components.a, {\n href: \"https://github.com/mintlify/starter\",\n children: \"starter kit\"\n }), \". We use GitHub to integrate\\nyour docs with your code, and make source control effortless. Onboard through the \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com\",\n children: \"dashboard\"\n }), \" or clone our \", _jsx(_components.a, {\n href: \"https://github.com/mintlify/starter\",\n children: \"starter kit\"\n }), \" to get started.\"]\n }), \"\\n\", _jsxs(AccordionGroup, {\n children: [_jsxs(Accordion, {\n icon: \"message-bot\",\n title: \"Install the GitHub app\",\n children: [_jsxs(_components.p, {\n children: [\"Install our GitHub app to ensure that your updates are automatically deployed when you push changes. You can find the installation link in the \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com/settings\",\n children: \"dashboard\"\n }), \", on the Settings page. Upon successful installation, a check mark will appear next to the commit hash of the repository.\"]\n }), _jsx(Frame, {\n children: _jsx(_components.p, {\n children: _jsx(_components.img, {\n src: \"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/github-bot-verification.png\",\n alt: \"GitHub Bot Verification\"\n })\n })\n })]\n }), _jsxs(Accordion, {\n icon: \"code-branch\",\n title: \"Monorepo Setup\",\n children: [_jsxs(_components.p, {\n children: [\"If you want your docs to live alongside your code as a monorepo setup, you\\ncan: 1. Move your docs content to your monorepo. 2. Specify the path to your\\n\", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" in the\\n\", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com/settings/deployment/git-settings\",\n children: \"dashboard\"\n })]\n }), _jsxs(Frame, {\n children: [_jsx(ZoomImage, {\n children: _jsx(\"img\", {\n alt: \"Monorepo setup\",\n className: \"block dark:hidden\",\n src: \"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/monorepo-light.png\"\n })\n }), _jsx(ZoomImage, {\n children: _jsx(\"img\", {\n alt: \"Monorepo setup\",\n className: \"hidden dark:block\",\n src: \"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/monorepo-dark.png\"\n })\n })]\n })]\n })]\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"updating-the-content\",\n children: \"Updating the Content\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Mintlify enables you to easily customize the style, structure, and content of\\nyour docs.\"\n }), \"\\n\", _jsxs(AccordionGroup, {\n children: [_jsxs(Accordion, {\n icon: \"rectangle-terminal\",\n title: \"Editing locally (recommended for developers)\",\n children: [_jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Install \", _jsx(_components.a, {\n href: \"https://git-scm.com/book/en/v2/Getting-Started-Installing-Git\",\n children: \"git\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Once git is installed, clone your docs repository using \", _jsx(_components.code, {\n children: \"git clone \u003cyour-repo\u003e\"\n }), \". If you haven’t set it up yet, now would be a good time to do so with these \", _jsx(_components.a, {\n href: \"https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent\",\n children: \"SSH keys\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Use your favorite IDE to open the repository.\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Install our Mintlify CLI to preview changes with \", _jsx(_components.code, {\n children: \"npm i -g mintlify\"\n }), \".\"]\n }), \"\\n\"]\n }), _jsxs(_components.p, {\n children: [\"Learn more about this in our \", _jsx(_components.a, {\n href: \"/development\",\n children: \"local development guide\"\n }), \".\"]\n })]\n }), _jsx(Accordion, {\n icon: \"pen-to-square\",\n title: \"Editing with the web editor\",\n children: _jsxs(_components.p, {\n children: [\"Learn more about how to use the web editor on our \", _jsx(_components.a, {\n href: \"/web-editor\",\n children: \"guide\"\n }), \".\"]\n })\n }), _jsxs(Accordion, {\n icon: \"palette\",\n title: \"Customizing to your brand\",\n children: [_jsxs(_components.p, {\n children: [\"Easily customize colors, logos and buttons among other configurations in our \", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" file. Start with these basic configurations:\"]\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-json\",\n children: _jsxs(_components.code, {\n className: \"language-json\",\n children: [_jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"name\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"Your Company\\\"\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"logo\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token punctuation\",\n children: \"{\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"light\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"/logo/light.svg\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"dark\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"/logo/dark.svg\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"href\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"https://yourcompany.com\\\"\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token punctuation\",\n children: \"}\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"favicon\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"/favicon.svg\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"colors\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token punctuation\",\n children: \"{\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"primary\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"#2AB673\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"light\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"#55D799\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [\" \", _jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"dark\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"#117866\\\"\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\", _jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token punctuation\",\n children: \"}\"\n }), _jsx(_components.span, {\n className: \"token punctuation\",\n children: \",\"\n })]\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.p, {\n children: [\"A full list of supported configurations can be found at \", _jsx(_components.a, {\n href: \"/settings/global\",\n children: \"global settings\"\n }), \".\"]\n })]\n }), _jsxs(Accordion, {\n icon: \"pencil\",\n title: \"Adding content\",\n children: [_jsx(_components.p, {\n children: \"Add content with simple MDX files. Initiate your pages with this template:\"\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-md\",\n children: _jsxs(_components.code, {\n className: \"language-md\",\n children: [_jsx(_components.span, {\n className: \"\",\n children: _jsx(_components.span, {\n className: \"token hr punctuation\",\n children: \"---\"\n })\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: \"title: \\\"Page Title\\\"\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: \"sidebarTitle: \\\"Sidebar title (optional - if different from page title)\\\"\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: \"description: \\\"Subtitle (optional)\\\"\"\n }), \"\\n\", _jsx(_components.span, {\n className: \"\",\n children: _jsx(_components.span, {\n className: \"token hr punctuation\",\n children: \"---\"\n })\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.p, {\n children: [\"Learn more about adding images, tables, lists, and more using the \", _jsx(_components.a, {\n href: \"/text\",\n children: \"MDX syntax\"\n }), \". We also offer a \", _jsx(_components.a, {\n href: \"/content/components\",\n children: \"wide array of components\"\n }), \".\"]\n })]\n }), _jsxs(Accordion, {\n icon: \"rocket\",\n title: \"Pushing changes\",\n children: [_jsxs(_components.p, {\n children: [\"Once ready, commit and push your changes to update your docs site. Here is a \", _jsx(_components.a, {\n href: \"https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push\",\n children: \"guide\"\n }), \" on how to do that. If the GitHub app is unable to successfully deploy your changes, you can manually update your docs through our \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com\",\n children: \"dashboard\"\n }), \".\"]\n }), _jsx(Frame, {\n children: _jsx(_components.p, {\n children: _jsx(_components.img, {\n src: \"https://mintlify.s3-us-west-1.amazonaws.com/mintlify/images/manual-update.png\",\n alt: \"Manual\\nUpdate\"\n })\n })\n })]\n }), _jsxs(Accordion, {\n icon: \"code-branch\",\n title: \"Generating API references\",\n children: [_jsx(_components.p, {\n children: \"You can easily set up your API references using an OpenAPI document.\"\n }), _jsxs(_components.ol, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Add your \", _jsx(_components.code, {\n children: \"openapi.yaml\"\n }), \" or \", _jsx(_components.code, {\n children: \"openapi.json\"\n }), \" file into your docs repository or define the \", _jsx(_components.code, {\n children: \"openapi\"\n }), \" field in \", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" with a URL.\"]\n }), \"\\n\"]\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-json\",\n children: _jsxs(_components.code, {\n className: \"language-json\",\n children: [_jsxs(_components.span, {\n className: \"\",\n children: [_jsx(_components.span, {\n className: \"token property\",\n children: \"\\\"openapi\\\"\"\n }), _jsx(_components.span, {\n className: \"token operator\",\n children: \":\"\n }), \" \", _jsx(_components.span, {\n className: \"token string\",\n children: \"\\\"link-to-your-openapi-file\\\"\"\n })]\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.ol, {\n start: \"2\",\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Use our \", _jsx(_components.a, {\n href: \"/api-playground/openapi/setup#autogenerate-files-recommended\",\n children: \"scraper\"\n }), \" to autogenerate your OpenAPI endpoints files as:\"]\n }), \"\\n\"]\n }), _jsx(CodeBlock, {\n filename: \"\",\n expandable: \"false\",\n children: _jsx(_components.pre, {\n className: \"language-bash\",\n children: _jsxs(_components.code, {\n className: \"language-bash\",\n children: [_jsxs(_components.span, {\n className: \"\",\n children: [\"npx @mintlify/scraping@latest openapi-file \", _jsx(_components.span, {\n className: \"token operator\",\n children: \"\u003c\"\n }), \"path-or-url-to-openapi-file\", _jsx(_components.span, {\n className: \"token operator\",\n children: \"\u003e\"\n })]\n }), \"\\n\"]\n })\n })\n }), _jsxs(_components.ol, {\n start: \"3\",\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Finally, include the generated endpoint MDX files to your \", _jsx(_components.code, {\n children: \"docs.json\"\n }), \" under \", _jsx(_components.code, {\n children: \"navigation\"\n }), \".\"]\n }), \"\\n\"]\n }), _jsxs(_components.p, {\n children: [\"For a complete guide on using Mintlify with OpenAPI, check out \", _jsx(_components.a, {\n href: \"/api-playground/openapi/setup\",\n children: \"this guide\"\n }), \". \", _jsx(_components.a, {\n href: \"/api-playground/openapi/writing-openapi\",\n children: \"This guide\"\n }), \" explains how to configure your API authentication methods. For manual API references definition, explore \", _jsx(_components.a, {\n href: \"/api-playground/overview\",\n children: \"our syntax\"\n }), \".\"]\n })]\n }), _jsxs(Accordion, {\n icon: \"chart-simple\",\n title: \"Adding analytics\",\n children: [_jsxs(_components.p, {\n children: [\"Our in-house analytics give you insights into page views, search analytics, session recordings and more. Access these on your \", _jsx(_components.a, {\n href: \"https://dashboard.mintlify.com/analytics\",\n children: \"dashboard\"\n }), \".\"]\n }), _jsxs(_components.p, {\n children: [\"We also support integrations with a range of analytics providers. You can find the list of providers \", _jsx(_components.a, {\n href: \"/integrations/analytics/overview\",\n children: \"here\"\n }), \".\"]\n })]\n })]\n }), \"\\n\", _jsx(Note, {\n children: _jsxs(_components.p, {\n children: [\"We provide a white-glove migration service as part of our Enterprise plan.\\nInterested? You can request it by \", _jsx(_components.a, {\n href: \"mailto:sales@mintlify.com\",\n children: \"contacting us\"\n }), \".\"]\n })\n }), \"\\n\", _jsx(Heading, {\n level: \"3\",\n id: \"publishing\",\n children: \"Publishing\"\n }), \"\\n\", _jsxs(Accordion, {\n icon: \"star\",\n title: \"Adding a custom domain\",\n children: [_jsx(_components.p, {\n children: \"Integrate your docs into your website by hosting them on a custom domain. This is included in the free plan.\"\n }), _jsxs(_components.p, {\n children: [\"Navigate to your \", _jsx(_components.a, {\n href: \"https://www.dashboard.mintlify.com/settings\",\n children: \"dashboard settings\"\n }), \" to add a custom domain.\"]\n }), _jsx(Frame, {\n children: _jsx(_components.img, {\n src: \"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/images/custom-domain.png\",\n alt: \"Custom Domain\"\n })\n })]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Congrats! You’ve set up your Mintlify Docs and it’s looking amazing! Need\\nsupport or want to give some feedback? You can join our\\n\", _jsx(_components.a, {\n href: \"https://mintlify.com/community\",\n children: \"community\"\n }), \" or drop us an email at\\n\", _jsx(_components.a, {\n href: \"mailto:support@mintlify.com\",\n children: \"support@mintlify.com\"\n }), \".\"]\n })]\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};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{"config":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Mintlify","colors":{"primary":"#0D9373","light":"#55D799","dark":"#0D9373"},"logo":{"light":"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/light.svg","dark":"https://mintlify.s3.us-west-1.amazonaws.com/mintlify/logo/dark.svg","href":"https://mintlify.com"},"favicon":"/favicon.svg","api":{"mdx":{"auth":{"method":"bearer"}}},"navbar":{"links":[{"label":"Community","href":"https://mintlify.com/community"}],"primary":{"type":"button","label":"Get Started","href":"https://mintlify.com/start"}},"navigation":{"dropdowns":[{"dropdown":"Getting Started","icon":"book","description":"Set up your documentation","groups":[{"group":"Getting Started","pages":["quickstart",{"group":"Editing","icon":"pen-paintbrush","pages":["development","web-editor"]},"settings/global",{"group":"Navigation","icon":"map","pages":["navigation/overview","navigation/pages","navigation/divisions","navigation/versions","navigation/localization"]},"migration"]},{"group":"Writing Content","pages":["page","text","image-embeds","list-table","code","reusable-snippets"]},{"group":"API References","pages":["api-playground/overview",{"group":"OpenAPI","icon":"brackets-curly","pages":["api-playground/openapi/setup","api-playground/openapi/writing-openapi","api-playground/openapi/advanced-features"]},{"group":"MDX","icon":"markdown","pages":["api-playground/mdx/configuration","api-playground/mdx/authentication"]},"api-playground/troubleshooting"]},{"group":"Configurations","pages":["settings/custom-domain","settings/seo","settings/custom-scripts","settings/broken-links","settings/github","settings/gitlab","settings/ci","settings/preview-deployments"]},{"group":"Advanced","pages":[{"group":"Custom Subdirectory","icon":"folder","pages":["advanced/subpath/cloudflare","advanced/subpath/route53-cloudfront","advanced/subpath/vercel"]},{"group":"Auth \u0026 Personalization","icon":"user-lock","pages":["settings/authentication-personalization/authentication","settings/authentication-personalization/partial-authentication","settings/authentication-personalization/personalization","settings/authentication-personalization/authentication-vs-personalization",{"group":"Authentication Setup","pages":["settings/authentication-personalization/authentication-setup/choosing-a-handshake","settings/authentication-personalization/authentication-setup/password","settings/authentication-personalization/authentication-setup/jwt","settings/authentication-personalization/authentication-setup/oauth","settings/authentication-personalization/authentication-setup/mintlify"]},{"group":"Personalization Setup","pages":["settings/authentication-personalization/personalization-setup/choosing-a-handshake","settings/authentication-personalization/personalization-setup/shared-session","settings/authentication-personalization/personalization-setup/jwt","settings/authentication-personalization/personalization-setup/oauth"]},"settings/authentication-personalization/sending-data"]},{"group":"Dashboard Access","icon":"house-lock","pages":["advanced/dashboard/sso","advanced/dashboard/permissions"]},{"group":"REST API","icon":"brackets-curly","pages":["advanced/rest-api/overview",{"group":"Updates","pages":["advanced/rest-api/update/trigger","advanced/rest-api/update/status"]},{"group":"Chat API","pages":["advanced/rest-api/chat/create-topic","advanced/rest-api/chat/generate-message"]}]}]}]},{"dropdown":"Components","icon":"block-brick","description":"Component library","groups":[{"group":"Components","pages":["content/components/accordions","content/components/accordion-groups","content/components/callouts","content/components/cards","content/components/card-groups","content/components/code","content/components/code-groups","content/components/frames","content/components/icons","content/components/mermaid-diagrams","content/components/steps","content/components/tabs","content/components/tooltips","content/components/update"]},{"group":"API Components","pages":["content/components/params","content/components/responses","content/components/expandables","content/components/sticky-examples"]}]},{"dropdown":"Integrations","icon":"plug","description":"Connect your providers","groups":[{"group":"Analytics","pages":["integrations/analytics/overview","integrations/analytics/amplitude","integrations/analytics/clearbit","integrations/analytics/fathom","integrations/analytics/google-analytics","integrations/analytics/google-tag-manager","integrations/analytics/heap","integrations/analytics/hotjar","integrations/analytics/koala","integrations/analytics/logrocket","integrations/analytics/mixpanel","integrations/analytics/pirsch","integrations/analytics/plausible","integrations/analytics/posthog","integrations/analytics/segment"]},{"group":"SDKs","pages":["integrations/sdks/speakeasy","integrations/sdks/stainless"]},{"group":"Support","pages":["integrations/support/overview","integrations/support/intercom","integrations/support/front"]},{"group":"Privacy","pages":["integrations/privacy/overview","integrations/privacy/osano"]}]},{"dropdown":"Changelog","icon":"list-timeline","description":"Updates and changes","groups":[{"group":"Changelog","pages":["changelog/overview"]}]}]},"footer":{"socials":{"x":"https://x.com/mintlify","linkedin":"https://www.linkedin.com/company/mintlify","github":"https://github.com/mintlify","slack":"https://mintlify.com/community"},"links":[{"header":"Resources","items":[{"label":"Customers","href":"https://mintlify.com/customers"},{"label":"Enterprise","href":"https://mintlify.com/enterprise"},{"label":"Request Preview","href":"https://mintlify.com/preview"},{"label":"Integrations","href":"https://mintlify.com/docs/integrations/analytics/overview"},{"label":"Templates","href":"https://github.com/mintlify/themes"},{"label":"Wall of Love","href":"https://mintlify.com/love"}]},{"header":"Company","items":[{"label":"Careers","href":"https://mintlify.com/careers"},{"label":"Blog","href":"https://mintlify.com/blog"},{"label":"Public Roadmap","href":"https://feedback.mintlify.com/roadmap"},{"label":"Security","href":"https://mintlify.com/security/responsible-disclosure"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://mintlify.com/legal/privacy"},{"label":"Terms of Service","href":"https://mintlify.com/legal/terms"}]}]},"integrations":{"ga4":{"measurementId":"G-RCYWHL7EQ7"},"koala":{"publicApiKey":"pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"}}},"pageMetadata":{"title":"Quickstart","description":"Start building modern documentation in under five minutes","icon":"rocket","href":"/quickstart"}}},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"gitSource":{"type":"github","owner":"mintlify","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true}},"__N_SSG":true},"page":"/_sites/[subdomain]/[[...slug]]","query":{"subdomain":"mintlify","slug":["quickstart"]},"buildId":"s_rCgYEQNhgGM0glymDTI","assetPrefix":"/docs","isFallback":false,"isExperimentalCompile":false,"gsp":true,"scriptLoader":[]}</script></html></body></html>