CINXE.COM

Quickstart — Fern

<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><script id="_fern-gtm"> (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-55W3VNDW'); </script><link rel="preload" href="/learn/api/fern-docs/search/v2/key" as="fetch" crossorigin="anonymous"/><meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"/><title>Quickstart — Fern</title><meta name="robots" content="index,follow"/><meta name="description" content="Start building beautiful documentation in under 5 minutes"/><meta name="theme-color" content="#fbfffa"/><meta property="og:title" content="Quickstart — Fern"/><meta property="og:description" content="Start building beautiful documentation in under 5 minutes"/><meta property="og:url" content="https://buildwithfern.com/learn/docs/getting-started/quickstart"/><meta property="og:site_name" content="Fern"/><link rel="canonical" href="https://buildwithfern.com/learn/docs/getting-started/quickstart"/><meta name="generator" content="buildwithfern.com"/><link rel="icon" href="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/favicon.ico" crossorigin="anonymous"/><link rel="preload" href="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><link rel="preload" href="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Medium.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><link rel="preload" href="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2" as="font" type="font/woff2" crossorigin="anonymous"/><script type="application/ld+json" id="jsonld-breadcrumb">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Fern","item":"https://buildwithfern.com/learn"},{"@type":"ListItem","position":2,"name":"Docs","item":"https://buildwithfern.com/learn/docs"},{"@type":"ListItem","position":3,"name":"Getting Started","item":"https://buildwithfern.com/learn/docs/getting-started"},{"@type":"ListItem","position":4,"name":"Quickstart","item":"https://buildwithfern.com/learn/docs/getting-started/quickstart"}]}</script><link rel="preload" href="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/logo-primary.svg" as="image" fetchpriority="high"/><link rel="preload" href="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/logo-white.svg" as="image" fetchpriority="high"/><meta name="next-head-count" content="21"/><link href="https://cdn.jsdelivr.net/npm/katex@0.16.8/dist/katex.min.css" rel="stylesheet"/><script id="theme-script" data-nscript="beforeInteractive">(e=>{let t=document.documentElement;function n(e){t.classList.remove("light","dark"),t.classList.add(e),t.style.colorScheme=e}if(1===e.length)n(e[0]);else try{let t=localStorage.getItem("theme")??"system",r=e.length>0&&"system"===t?window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light":t;n(r)}catch{}})(["light","dark"])</script><link rel="preload" href="https://app.ferndocs.com/_next/static/css/9ea35506dfe64fe9.css?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" as="style"/><link rel="stylesheet" href="https://app.ferndocs.com/_next/static/css/9ea35506dfe64fe9.css?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" data-n-g=""/><link rel="preload" href="https://app.ferndocs.com/_next/static/css/80bca615e6d01b34.css?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" as="style"/><link rel="stylesheet" href="https://app.ferndocs.com/_next/static/css/80bca615e6d01b34.css?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"/><noscript data-n-css=""></noscript><script defer="" nomodule="" src="https://app.ferndocs.com/_next/static/chunks/polyfills-78c92fac7aa8fdd8.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/8494.89309af69f67ac9d.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/7191.7664a652cf78e25c.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/9862.425ab7b1c7aa2bbe.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/45bb0db8.463a392675fecfb0.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/92e66809.393f81705c519a34.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/118f301d.0a7382916ef4ac18.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/52d2be3c.b954481fe5a6d824.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/f29dc6a8.0d3c3c8683df2eda.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/6003.c51da136c4cdc4e2.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/8950.bc07b3e1c13f1432.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/9447.941fe43d074e9d65.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/3970.92d61b16d27aa382.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/600.41bc3a7574a6657d.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/9288.89b55b0145592967.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/f136264b.fe05aaa57e22d479.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/4217.08fff909190d4e30.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/2729.42c77bdb2d91a65d.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/9042.c499308c3ab0fd61.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/8326.bde182ef6c372b2f.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/6454.9b646f472ba09fdb.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/8508.347822f577367398.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/5119.7fbcb17fea114486.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/5438.9dfc11fa11c8ee42.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/6770.51b46eee98dbcf4b.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/7708.bec065f6e20bb795.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/a20b1002.4488a96695dd3fd2.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/2190.87861bd25f72541a.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/8909.f1f37f32cfbdca2f.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/5817.ecbdb071b2037947.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/5777.8b41b53f8bbbac5b.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script defer="" src="https://app.ferndocs.com/_next/static/chunks/6993.0ee3a85a35a7f922.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm"></script><script src="https://app.ferndocs.com/_next/static/chunks/webpack-78a47aa46c6ce20e.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/chunks/framework-66d89474ad83799b.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/chunks/main-329ceaff5bef80bb.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/chunks/pages/_app-ab4df84d04f226ed.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/chunks/2709-cda5da4a8db8de58.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/chunks/6053-8d9234f9b6157ebd.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/chunks/pages/static/%5Bdomain%5D/%5B%5B...slug%5D%5D-31f428dae64597dc.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/QJggA6sLAGu-ommXPhsGG/_buildManifest.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><script src="https://app.ferndocs.com/_next/static/QJggA6sLAGu-ommXPhsGG/_ssgManifest.js?dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm" defer=""></script><style id="__jsx-1412600766"> :root { --typography-body-font-family: 'GT-Planar', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif; --typography-heading-font-family: 'GT-Planar-Bold', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif; --typography-code-font-family: ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace; --spacing-page-width: 1504px; --spacing-content-width: 44rem; --spacing-content-wide-width: 66.5rem; --spacing-sidebar-width: 18rem; --spacing-header-height: 7.4375rem; --spacing-header-height-padded: 91px; --spacing-header-height-real: 4.6875rem; --grayscale-1: var(--sand-1); --grayscale-2: var(--sand-2); --grayscale-3: var(--sand-3); --grayscale-4: var(--sand-4); --grayscale-5: var(--sand-5); --grayscale-6: var(--sand-6); --grayscale-7: var(--sand-7); --grayscale-8: var(--sand-8); --grayscale-9: var(--sand-9); --grayscale-10: var(--sand-10); --grayscale-11: var(--sand-11); --grayscale-12: var(--sand-12); --grayscale-a1: var(--sand-a1); --grayscale-a2: var(--sand-a2); --grayscale-a3: var(--sand-a3); --grayscale-a4: var(--sand-a4); --grayscale-a5: var(--sand-a5); --grayscale-a6: var(--sand-a6); --grayscale-a7: var(--sand-a7); --grayscale-a8: var(--sand-a8); --grayscale-a9: var(--sand-a9); --grayscale-a10: var(--sand-a10); --grayscale-a11: var(--sand-a11); --grayscale-a12: var(--sand-a12); --accent-1: #f8fdf8; --accent-2: #f0fbf0; --accent-3: #d1fed0; --accent-4: #b4fcb4; --accent-5: #98f699; --accent-6: #86e888; --accent-7: #73d476; --accent-8: #5bbc5f; --accent-9: #0d4c14; --accent-10: #235e26; --accent-11: #188326; --accent-12: #06480f; --accent-a1: #3c807b04; --accent-a2: #12aa260c; --accent-a3: #02fa012b; --accent-a4: #03f50649; --accent-a5: #01e90665; --accent-a6: #01ce0677; --accent-a7: #02b1088b; --accent-a8: #009608a3; --accent-a9: #004207f2; --accent-a10: #014405dc; --accent-a11: #007610e7; --accent-a12: #004409f9; --accent-surface: #eefaeecc; --gray-surface: #ffffffcc; --accent: 13, 76, 20; --accent-aa: 13, 76, 20; --accent-aaa: 13, 76, 20; --accent-tinted: 9, 54, 14; --background: 251, 255, 250; --accent-contrast: rgb(255, 255, 255); --bg-color-card: rgba(255, 255, 255, 0.7); --sidebar-background: transparent; --header-background: rgb(251, 255, 250); --border: var(--grayscale-a4); --border-concealed: var(--grayscale-a2); --body-text: 0, 0, 0; --body-text-inverted: 255, 255, 255; } @media (max-width: 1024px) { :root { --spacing-header-height: 7.4375rem; --spacing-header-height-padded: 91px; } } :is(.dark) { --grayscale-1: var(--olive-1); --grayscale-2: var(--olive-2); --grayscale-3: var(--olive-3); --grayscale-4: var(--olive-4); --grayscale-5: var(--olive-5); --grayscale-6: var(--olive-6); --grayscale-7: var(--olive-7); --grayscale-8: var(--olive-8); --grayscale-9: var(--olive-9); --grayscale-10: var(--olive-10); --grayscale-11: var(--olive-11); --grayscale-12: var(--olive-12); --grayscale-a1: var(--olive-a1); --grayscale-a2: var(--olive-a2); --grayscale-a3: var(--olive-a3); --grayscale-a4: var(--olive-a4); --grayscale-a5: var(--olive-a5); --grayscale-a6: var(--olive-a6); --grayscale-a7: var(--olive-a7); --grayscale-a8: var(--olive-a8); --grayscale-a9: var(--olive-a9); --grayscale-a10: var(--olive-a10); --grayscale-a11: var(--olive-a11); --grayscale-a12: var(--olive-a12); --accent-1: #091009; --accent-2: #111b11; --accent-3: #132d13; --accent-4: #123c13; --accent-5: #184a19; --accent-6: #205921; --accent-7: #276a29; --accent-8: #2d7f30; --accent-9: #2bdb3c; --accent-10: #0ed02d; --accent-11: #2cdc3d; --accent-12: #aff5ad; --accent-a1: #88108802; --accent-a2: #c8fac80c; --accent-a3: #63ff631f; --accent-a4: #3eff432f; --accent-a5: #4aff4e3e; --accent-a6: #56ff594e; --accent-a7: #5afd5f61; --accent-a8: #58fd5e77; --accent-a9: #31ff45d9; --accent-a10: #0fff36cd; --accent-a11: #32ff46da; --accent-a12: #b6feb4f5; --accent-surface: color(display-p3 0.1098 0.1412 0.102 / 0.5); --gray-surface: color(display-p3 0 0 0 / 5%); --accent: 43, 219, 60; --accent-aa: 43, 219, 60; --accent-aaa: 43, 219, 60; --accent-tinted: 65, 223, 80; --background: 8, 16, 8; --accent-contrast: rgb(21, 39, 21); --bg-color-card: rgba(5, 9, 5, 0.5); --bg-color-card-solid: rgb(6, 13, 6); --sidebar-background: transparent; --header-background: rgb(8, 16, 8); --border: var(--grayscale-a4); --border-concealed: var(--grayscale-a2); --body-text: 255, 255, 255; --body-text-inverted: 0, 0, 0; } @font-face { font-family: 'GT-Planar'; src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar.woff2') format('woff2'); font-weight: 400; font-style: normal; font-display: swap; } @font-face { font-family: 'GT-Planar'; src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Medium.woff2') format('woff2'); font-weight: 500; font-style: normal; font-display: swap; } @font-face { font-family: 'GT-Planar'; src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2') format('woff2'); font-weight: 600 700; font-style: normal; font-display: swap; } @font-face { font-family: 'GT-Planar-Bold'; src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2') format('woff2'); font-weight: 600 700; font-style: normal; font-display: swap; } html { background-color: #fbfffa; } html.dark { background-color: #081008; } .motivation p { max-width: unset !important; } .showcase h2 { margin-bottom: 0.25em; } :is(.dark) .showcase .logo-icon { filter: invert(1); margin-top: 0px; margin-bottom: 0px; } .logo-icon { margin-right: 10px; } </style><style id="__jsx-3414788811">:root{ --header-offset: 119px}@media(max-width:1024px){:root{--header-offset:75px}}</style></head><body class="antialiased"><div id="__next"><noscript id="_fern-gtm-noscript"><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-55W3VNDW" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><div class="fern-background dark:from-transparent"></div><div id="fern-docs" class="fern-container fern-theme-default"><header id="fern-header" role="banner"><div class="fern-header-container width-before-scroll-bar has-background-light has-background-dark" data-border="hide"><div class="clipped-background"><div class="h-screen opacity-60 dark:opacity-80 fern-background dark:from-transparent"></div></div><div class="fern-header"><nav aria-label="primary" class="fern-header-content max-w-page-width mx-auto"><div class="relative flex h-full min-w-fit flex-1 shrink-0 items-center gap-2 py-1"><div class="flex items-center gap-2"><a target="_blank" rel="noreferrer" href="https://www.buildwithfern.com/"><div class="fern-logo-container"><img alt="Fern" fetchpriority="high" loading="eager" width="1370" height="480" decoding="async" data-nimg="1" class="fern-logo-light" style="color:transparent;aspect-ratio:2.8541666666666665;height:30px;width:auto" src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/logo-primary.svg"/><img alt="Fern" fetchpriority="high" loading="eager" width="1370" height="480" decoding="async" data-nimg="1" class="fern-logo-dark" style="color:transparent;aspect-ratio:2.8541666666666665;height:30px;width:auto" src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/logo-white.svg"/></div></a></div></div><div class="fern-header-searchbar"><button class="inline-flex h-9 w-full cursor-text items-center justify-start gap-2 whitespace-nowrap rounded-md p-2 text-sm font-medium transition-colors hover:transition-none focus-visible:outline-none focus-visible:ring-1 focus-visible:ring-[var(--accent-6)] disabled:pointer-events-none disabled:opacity-50 [&amp;_svg]:pointer-events-none [&amp;_svg]:size-4 [&amp;_svg]:shrink-0 cursor-default bg-[var(--grayscale-a3)] text-[var(--grayscale-a10)]"><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-search"><circle cx="11" cy="11" r="8"></circle><path d="m21 21-4.3-4.3"></path></svg>Search<span class="inline-flex gap-1 ml-auto"><kbd class="fern-kbd">/</kbd></span></button></div><div class="fern-header-right-menu flex-1"><div class="lg-menu"><span class="fern-button-group"><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button minimal normal" href="https://buildwithfern.com/slack"><span class="fern-button-content"><span class="fern-button-text">Slack community</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="group cursor-pointer fern-button filled normal primary" href="https://buildwithfern.com/contact"><span class="fern-button-content"><span class="fern-button-text">Book a demo</span><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon transition-transform group-hover:translate-x-0.5"><path d="M3 12L21 12M21 12L12.5 3.5M21 12L12.5 20.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a><button tabindex="0" data-state="closed" aria-disabled="false" title="toggle theme" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R9t4um:" class="fern-theme-button fern-button minimal normal primary rounded square"><span class="fern-button-content"><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="fern-theme-button-icon !size-icon max-lg:!size-icon-md"><circle cx="12" cy="12" r="5"></circle><line x1="12" y1="1" x2="12" y2="3"></line><line x1="12" y1="21" x2="12" y2="23"></line><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line><line x1="1" y1="12" x2="3" y2="12"></line><line x1="21" y1="12" x2="23" y2="12"></line><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line></svg></span></button></span></div><div class="max-lg-menu"><button tabindex="0" data-state="closed" aria-disabled="false" title="toggle theme" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:Rat4um:" class="fern-theme-button fern-button minimal large primary rounded square"><span class="fern-button-content"><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="fern-theme-button-icon !size-icon max-lg:!size-icon-md"><circle cx="12" cy="12" r="5"></circle><line x1="12" y1="1" x2="12" y2="3"></line><line x1="12" y1="21" x2="12" y2="23"></line><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line><line x1="1" y1="12" x2="3" y2="12"></line><line x1="21" y1="12" x2="23" y2="12"></line><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line></svg></span></button><button tabindex="0" disabled="" data-state="off" aria-disabled="true" data-selected="false" id="fern-search-button" class="max-sm:block fern-button minimal large disabled rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon-md"><path d="M17 17L21 21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 11C3 15.4183 6.58172 19 11 19C13.213 19 15.2161 18.1015 16.6644 16.6493C18.1077 15.2022 19 13.2053 19 11C19 6.58172 15.4183 3 11 3C6.58172 3 3 6.58172 3 11Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button><button tabindex="0" data-state="off" aria-disabled="false" class="fern-button minimal large rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon-md"><path d="M3 5H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 12H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 19H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></nav></div><nav aria-label="tabs" class="fern-header-tabs"><ul class="fern-header-tabs-list"><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="inactive" href="/learn"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/home.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/home.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span><span class="truncate font-medium">Home</span></div></a></li><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="inactive" href="/learn/api-definition/introduction/what-is-an-api-definition"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/book.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/book.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span><span class="truncate font-medium">API Definition</span></div></a></li><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="inactive" href="/learn/sdks/introduction/overview"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/brands/codepen.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/brands/codepen.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span><span class="truncate font-medium">SDKs</span></div></a></li><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="active" href="/learn/docs/getting-started/overview"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/browser.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/browser.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span><span class="truncate font-medium">Docs</span></div></a></li><li class="fern-header-tabs-list-item"><a class="fern-header-tab-button" data-state="inactive" href="/learn/cli-reference/overview"><div class="flex min-w-0 items-center justify-start space-x-2"><span class="fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/code.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/code.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span><span class="truncate font-medium">CLI &amp; API Reference</span></div></a></li></ul></nav></div></header><style> .fern-sidebar-container { border-right-width: 0px; border-left-width: 0px; } :is(.dark) .fern-sidebar-container { border-right-width: 0px; border-left-width: 0px; } </style><div class="fern-body"><nav aria-label="secondary" class="fern-sidebar-container desktop"><div dir="ltr" class="fern-scroll-area flex-1" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport group/sidebar fern-sidebar-content" data-scrollbars="vertical" style="overflow-x:hidden;overflow-y:hidden"><div style="min-width:100%;display:table"><ul class="fern-sidebar-tabs lg:hidden"><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="inactive" href="/learn"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/home.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/home.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">Home</span></div></a></li><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="inactive" href="/learn/api-definition/introduction/what-is-an-api-definition"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/book.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/book.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">API Definition</span></div></a></li><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="inactive" href="/learn/sdks/introduction/overview"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/brands/codepen.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/brands/codepen.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">SDKs</span></div></a></li><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="active" href="/learn/docs/getting-started/overview"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/browser.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/browser.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">Docs</span></div></a></li><li><a class="min-h-[32px] lg:min-h-[36px] group/tab-button hover:t-accent flex min-w-0 flex-1 select-none items-center justify-start rounded-lg py-2 text-base group-hover/tab-button:transition lg:px-3 lg:text-sm data-[state=inactive]:t-muted data-[state=active]:t-accent" data-state="inactive" href="/learn/cli-reference/overview"><div class="flex min-w-0 items-center justify-start space-x-4"><div class="min-w-fit"><div class="bg-card-surface ring-border-default group-hover/tab-button:bg-tag-primary group-hover/tab-button:ring-accent/70 group-data-[state=active]/tab-button:bg-accent group-hover/tab-button:group-data-[state=active]/tab-button:bg-accent flex size-6 items-center justify-center rounded-md shadow-sm ring-1 group-data-[state=active]/tab-button:ring-0"><span class="bg-faded group-hover/tab-button:bg-accent group-data-[state=active]/tab-button:bg-background group-hover/tab-button:group-data-[state=active]/tab-button:bg-background size-4 fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/code.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/code.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></div></div><span class="truncate font-medium group-data-[state=active]/tab-button:font-semibold">CLI &amp; API Reference</span></div></a></li></ul><ul class="fern-sidebar-group"><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">Getting Started</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/getting-started/overview"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/book-open.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/book-open.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Overview</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/getting-started/customer-showcase"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/star.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/star.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Docs Customer Showcase</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="active"><a class="fern-sidebar-link" href="/learn/docs/getting-started/quickstart"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/bolt.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/bolt.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Quickstart</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/getting-started/global-configuration"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/gear.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/gear.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Global Configuration</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/getting-started/project-structure"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/diagram-project.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/diagram-project.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Project Structure</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/getting-started/development"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/desktop.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/desktop.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Preview your Docs</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/getting-started/publish-your-docs"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/cloud-arrow-up.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/cloud-arrow-up.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Publish your Docs</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" data-state="closed" href="/learn/docs/getting-started/changelog"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-4"><path d="M15 4V2M15 4V6M15 4H10.5M3 10V19C3 20.1046 3.89543 21 5 21H19C20.1046 21 21 20.1046 21 19V10H3Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M3 10V6C3 4.89543 3.89543 4 5 4H7" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M7 2V6" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 10V6C21 4.89543 20.1046 4 19 4H18.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span><span class="fern-sidebar-link-text">Changelog</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">Building and Customizing Your Docs</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/navigation"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/map-signs.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/map-signs.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Navigation</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/versioning"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/code-branch.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/code-branch.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Versioning</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/announcements"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/bullhorn.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/bullhorn.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Announcement Banner</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/links-and-redirects"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/link.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/link.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Links and Redirects</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/customizing-slugs"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/pen-to-square.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/pen-to-square.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Customizing Slugs</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/hiding-content"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/eye-slash.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/eye-slash.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Hiding Content</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/custom-css-global-js"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/palette.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/palette.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Custom CSS &amp; Global JS</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/pull-request-preview"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/magnifying-glass.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/magnifying-glass.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Pull Request Preview</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/custom-domain"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/globe.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/globe.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Custom Domain</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/user-feedback"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/comment-dots.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/comment-dots.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Edit This Page and User Feedback</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/building-and-customizing-your-docs/rbac"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/lock.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/lock.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Role based access control (RBAC)</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">Writing Content</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/content/write-markdown"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/font.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/font.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Write Markdown Content</span></span></a></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/puzzle-piece.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/puzzle-piece.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Components</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/content/frontmatter"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/sliders.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/sliders.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Frontmatter</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/content/reusable-snippets"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/recycle.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/recycle.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Reusable Snippets</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/content/changelog"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/clock-rotate-left.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/clock-rotate-left.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Changelog</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">API References</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/generate-api-ref"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/wand-sparkles.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/wand-sparkles.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Generate API Reference</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/sdk-snippets"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/brackets-curly.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/brackets-curly.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">SDK Snippets</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/http-snippets"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/code.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/code.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">HTTP Snippets</span></span></a></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/api-explorer"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/play.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/play.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">API Explorer</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a></div></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/endpoint-errors"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/triangle-exclamation.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/triangle-exclamation.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Endpoint Errors</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/audiences"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/user-group.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/user-group.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Audiences</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/customize-api-reference-layout"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/arrows-up-down-left-right.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/arrows-up-down-left-right.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Customize API Reference Layout</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/write-markdown-in-api-reference"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/pencil.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/pencil.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Write Markdown in API Reference</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/api-references/generate-webhook-reference"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/webhook.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/webhook.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Generate Webhook Reference</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">Integrations</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/integrations/overview"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/plug.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/plug.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Overview</span></span></a></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/chart-line.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/chart-line.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Analytics</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div data-state="closed"><div class="fern-sidebar-link-container" data-state="inactive"><button class="fern-sidebar-link"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/headset.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/headset.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Support</span></span><span class="fern-sidebar-link-expand opacity-50 transition-opacity group-hover:opacity-80" data-state="inactive"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md lg:size-icon -rotate-90"><path d="M6 9L12 15L18 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/integrations/postman"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/solid/user-astronaut.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/solid/user-astronaut.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Postman</span></span></a></div></li></ul></li><li class="mt-6"><div class="fern-sidebar-heading"><span class="fern-sidebar-heading-content">Developer Tools</span></div><ul class="fern-sidebar-group"><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/developer-tools/llms-txt"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/laptop-code.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/laptop-code.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">LLMs.txt</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/developer-tools/cursor"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/mouse-pointer.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/mouse-pointer.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Cursor</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/developer-tools/gitlab"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/brands/gitlab.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/brands/gitlab.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">GitLab</span></span></a></div></li><li><div class="fern-sidebar-link-container" data-state="inactive"><a class="fern-sidebar-link" href="/learn/docs/developer-tools/vale"><span class="fern-sidebar-link-content"><span class="fern-sidebar-icon"><span class="bg-faded group-data-[state=active]:bg-accent fa-icon" style="mask-image:url(&quot;https://icons.ferndocs.com/regular/shield-check.svg&quot;);mask-repeat:no-repeat;mask-position:center center;-webkit-mask-image:url(&quot;https://icons.ferndocs.com/regular/shield-check.svg&quot;);-webkit-mask-repeat:no-repeat;-webkit-mask-position:center center"></span></span><span class="fern-sidebar-link-text">Vale</span></span></a></div></li></ul></li><li class="mt-6"></li></ul><div class="border-concealed -mx-4 mt-4 list-none border-t p-4 lg:hidden"><a tabindex="0" aria-disabled="false" data-state="off" class="w-full fern-button minimal normal" href="https://buildwithfern.com/slack"><span class="fern-button-content"><span class="fern-button-text">Slack community</span></span></a><a tabindex="0" aria-disabled="false" data-state="off" class="w-full mt-2 fern-button filled normal primary" href="https://buildwithfern.com/contact"><span class="fern-button-content"><span class="fern-button-text">Book a demo</span><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="!size-icon"><path d="M3 12L21 12M21 12L12.5 3.5M21 12L12.5 20.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a></div></div></div></div></nav><div class="fern-main"><main class="fern-guide-layout"><aside class="fern-layout-toc"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport px-4 pb-12 pt-8 lg:pr-8" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden"><div style="min-width:100%;display:table"><div class="text-grayscale-a11 m-0 mb-3 text-sm font-medium">On this page</div><ul class="toc-root not-prose" style="--height:0px;--top:0px"><li class="mb-2 last:mb-0" data-depth="0"><a class="block hyphens-auto break-words text-sm transition-colors hover:transition-none text-grayscale-a11 hover:text-grayscale-a12" style="padding-left:0px" href="/learn/docs/getting-started/quickstart#initialize-your-fern-folder">Initialize your fern folder</a></li><li class="mb-2 last:mb-0" data-depth="0"><a class="block hyphens-auto break-words text-sm transition-colors hover:transition-none text-grayscale-a11 hover:text-grayscale-a12" style="padding-left:0px" href="/learn/docs/getting-started/quickstart#update-your-docs">Update your docs</a></li><li class="mb-2 last:mb-0" data-depth="0"><a class="block hyphens-auto break-words text-sm transition-colors hover:transition-none text-grayscale-a11 hover:text-grayscale-a12" style="padding-left:0px" href="/learn/docs/getting-started/quickstart#publish-to-production">Publish to production</a></li></ul></div></div></div></aside><article class="fern-layout-content max-w-content-width"><header class="mb-8"><div class="space-y-1"><div><span class="fern-breadcrumb"><a class="fern-breadcrumb-item" href="/learn/docs/getting-started/overview">Getting Started</a></span></div><h1 class="fern-page-heading"><p>Quickstart</p></h1></div><div class="prose-p:t-muted mt-2 leading-7"><p>Start building beautiful documentation in under 5 minutes</p></div></header><div class="prose dark:prose-invert prose-h1:mt-[1.5em] first:prose-h1:mt-0 max-w-full break-words"><span aria-owns="rmiz-modal-" data-rmiz=""><span data-rmiz-content="not-found" style="visibility:visible"><img alt="Docs cascade" loading="lazy" width="5504" height="3226" decoding="async" data-nimg="1" style="color:transparent;aspect-ratio:1.7061376317420955" srcSet="https://app.ferndocs.com/_next/image?url=https%3A%2F%2Ffiles.buildwithfern.com%2Ffern.docs.buildwithfern.com%2Flearn%2F2025-02-18T01%3A21%3A18.347Z%2Fpages%2Fdocs%2Fgetting-started%2Fdocs-cascade.png&amp;w=3840&amp;q=75&amp;dpl=dpl_5J5wdvgM59Y5piUdeKHa8mETq7Hm 1x" src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/pages/docs/getting-started/docs-cascade.png"/></span></span> <p>With Fern, you can build beautiful developer documentation that matches your brand. Fern supports writing pages (written in Markdown) and generating API Reference documentation (from an OpenAPI Specification).</p> <p>In this guide, we’ll show you how to get started with Fern in under 5 minutes.</p> <div class="fern-steps"><div class="fern-step scroll-mt-content-padded" id="initialize-your-fern-folder"><a class="fern-anchor" tabindex="-1" href="/learn/docs/getting-started/quickstart#initialize-your-fern-folder"><span class="fern-anchor-icon"><span>1</span></span></a><h3>Initialize your fern folder</h3><p>All the configurations for your docs live in the <code>fern</code> folder. Inside, you’ll find a <code>docs.yml</code> file that contains all the settings for your documentation.</p><div class="fern-accordion m-mdx" data-orientation="vertical"><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="clone-the-starter-repository"><summary type="button" aria-controls="radix-:Rbdel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:R3del8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Clone the starter repository</h6></summary><div data-state="closed" id="radix-:Rbdel8um:" role="region" aria-labelledby="radix-:R3del8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>Get started by cloning the <a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://github.com/fern-api/docs-starter">starter template<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a>.</p><div dir="ltr" data-orientation="horizontal" class="bg-card after:ring-card-border relative mb-6 mt-4 flex w-full min-w-0 max-w-full flex-col rounded-lg shadow-sm after:pointer-events-none after:absolute after:inset-0 after:rounded-[inherit] after:ring-1 after:ring-inset after:content-[&#x27;&#x27;] first:mt-0"><div class="bg-tag-default-soft rounded-t-[inherit]"><div class="shadow-border-default mx-px flex min-h-10 items-center justify-between shadow-[inset_0_-1px_0_0]"><div class="fern-x-overflow right-mask flex min-h-10"><button type="button" role="tab" aria-selected="true" aria-controls="radix-:Rardel8um:-content-0" data-state="active" id="radix-:Rardel8um:-trigger-0" class="data-[state=active]:shadow-accent group flex min-h-10 items-center px-2 py-1.5 data-[state=active]:shadow-[inset_0_-2px_0_0_rgba(0,0,0,0.1)]" tabindex="-1" data-orientation="horizontal" data-radix-collection-item=""><span class="t-muted group-data-[state=active]:t-default group-hover:bg-tag-default whitespace-nowrap rounded px-2 py-1 text-sm group-data-[state=active]:font-semibold">SSH</span></button><button type="button" role="tab" aria-selected="false" aria-controls="radix-:Rardel8um:-content-1" data-state="inactive" id="radix-:Rardel8um:-trigger-1" class="data-[state=active]:shadow-accent group flex min-h-10 items-center px-2 py-1.5 data-[state=active]:shadow-[inset_0_-2px_0_0_rgba(0,0,0,0.1)]" tabindex="-1" data-orientation="horizontal" data-radix-collection-item=""><span class="t-muted group-data-[state=active]:t-default group-hover:bg-tag-default whitespace-nowrap rounded px-2 py-1 text-sm group-data-[state=active]:font-semibold">HTTPS</span></button></div><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group ml-2 mr-1 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div><pre class="code-block-root not-prose rounded-t-0 rounded-b-[inherit]" style="animation-duration:0s" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line">git clone git@github.com:fern-api/docs-starter.git</span></td></tr></tbody></table></div></code></div></div></div></pre></div><p>Next, please update the template settings to use your organization.</p><div class="mb-6 mt-4 rounded-lg p-4 first:mt-0 callout-outlined-warning"><div class="flex items-start space-x-3"><div class="mt-0.5 w-4"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md text-intent-warning"><path d="M18 8.4C18 6.70261 17.3679 5.07475 16.2426 3.87452C15.1174 2.67428 13.5913 2 12 2C10.4087 2 8.88258 2.67428 7.75736 3.87452C6.63214 5.07475 6 6.70261 6 8.4C6 15.8667 3 18 3 18H21C21 18 18 15.8667 18 8.4Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M13.73 21C13.5542 21.3031 13.3019 21.5547 12.9982 21.7295C12.6946 21.9044 12.3504 21.9965 12 21.9965C11.6496 21.9965 11.3054 21.9044 11.0018 21.7295C10.6982 21.5547 10.4458 21.3031 10.27 21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></div><div class="prose prose-sm dark:prose-invert -my-4 flex-1 overflow-x-auto before:mb-4 before:block after:mt-4 after:block"><div class="text-intent-warning"><h5 class="leading-snug">Edit template settings</h5><p>Please edit the details <code>fern.config.json</code> and <code>docs.yml</code> with your organization name.</p><div dir="ltr" data-orientation="horizontal" class="bg-card after:ring-card-border relative mb-6 mt-4 flex w-full min-w-0 max-w-full flex-col rounded-lg shadow-sm after:pointer-events-none after:absolute after:inset-0 after:rounded-[inherit] after:ring-1 after:ring-inset after:content-[&#x27;&#x27;] first:mt-0"><div class="bg-tag-default-soft rounded-t-[inherit]"><div class="shadow-border-default mx-px flex min-h-10 items-center justify-between shadow-[inset_0_-1px_0_0]"><div class="fern-x-overflow right-mask flex min-h-10"><button type="button" role="tab" aria-selected="true" aria-controls="radix-:R1airdel8um:-content-0" data-state="active" id="radix-:R1airdel8um:-trigger-0" class="data-[state=active]:shadow-accent group flex min-h-10 items-center px-2 py-1.5 data-[state=active]:shadow-[inset_0_-2px_0_0_rgba(0,0,0,0.1)]" tabindex="-1" data-orientation="horizontal" data-radix-collection-item=""><span class="t-muted group-data-[state=active]:t-default group-hover:bg-tag-default whitespace-nowrap rounded px-2 py-1 text-sm group-data-[state=active]:font-semibold">fern.config.json</span></button><button type="button" role="tab" aria-selected="false" aria-controls="radix-:R1airdel8um:-content-1" data-state="inactive" id="radix-:R1airdel8um:-trigger-1" class="data-[state=active]:shadow-accent group flex min-h-10 items-center px-2 py-1.5 data-[state=active]:shadow-[inset_0_-2px_0_0_rgba(0,0,0,0.1)]" tabindex="-1" data-orientation="horizontal" data-radix-collection-item=""><span class="t-muted group-data-[state=active]:t-default group-hover:bg-tag-default whitespace-nowrap rounded px-2 py-1 text-sm group-data-[state=active]:font-semibold">docs.yml</span></button></div><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group ml-2 mr-1 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div><pre class="code-block-root not-prose rounded-t-0 rounded-b-[inherit]" style="animation-duration:0s" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>1</span></td><td class="code-block-line-content"><span class="line">{</span></td></tr><tr class="code-block-line highlight"><td class="code-block-line-gutter"><span>2</span></td><td class="code-block-line-content"><span class="line"> &quot;organization&quot;: &quot;{{YOUR_ORGANIZATION}}&quot;,</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>3</span></td><td class="code-block-line-content"><span class="line"> &quot;version&quot;: &quot;0.x.x&quot;</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>4</span></td><td class="code-block-line-content"><span class="line">}</span></td></tr></tbody></table></div></code></div></div></div></pre></div></div></div></div></div><p>Finally, run <code>fern generate --docs</code> to generate your documentation.</p></div></div></details><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="use-the-fern-cli"><summary type="button" aria-controls="radix-:Rddel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:R5del8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Use the Fern CLI</h6></summary><div data-state="closed" id="radix-:Rddel8um:" role="region" aria-labelledby="radix-:R5del8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>If you prefer, you can use our CLI to create a new project. Install the CLI by running</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line">npm install -g fern-api</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div><p>Then run</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line">fern init --docs</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div><p>You will see a new <code>fern</code> folder in your project with the following structure:</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line"> fern</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>&gt;</span></td><td class="code-block-line-content"><span class="line"> ├─ docs.yml</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>&gt;</span></td><td class="code-block-line-content"><span class="line"> └─ fern.config.json</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div><p>Finally, run <code>fern generate --docs</code> to generate your documentation.</p></div></div></details></div></div><div class="fern-step scroll-mt-content-padded" id="update-your-docs"><a class="fern-anchor" tabindex="-1" href="/learn/docs/getting-started/quickstart#update-your-docs"><span class="fern-anchor-icon"><span>2</span></span></a><h3>Update your docs</h3><div class="mb-6 mt-4 rounded-lg p-4 first:mt-0 callout-outlined-info"><div class="flex items-start space-x-3"><div class="mt-0.5 w-4"><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md text-intent-info"><path d="M9.5 14.5L3 21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M5.00007 9.48528L14.1925 18.6777L15.8895 16.9806L15.4974 13.1944L21.0065 8.5211L15.1568 2.67141L10.4834 8.18034L6.69713 7.78823L5.00007 9.48528Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></div><div class="prose prose-sm dark:prose-invert -my-4 flex-1 overflow-x-auto before:mb-4 before:block after:mt-4 after:block"><div class="text-intent-info"><h5 class="leading-snug"></h5><p>We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it <a class="fern-mdx-link" href="https://buildwithfern.com/contact">here</a>.</p></div></div></div></div><div class="fern-accordion m-mdx" data-orientation="vertical"><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="add-content"><summary type="button" aria-controls="radix-:Rbeel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:R3eel8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Add content</h6></summary><div data-state="closed" id="radix-:Rbeel8um:" role="region" aria-labelledby="radix-:R3eel8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>Add content with MDX files.</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>1</span></td><td class="code-block-line-content"><span class="line">---</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>2</span></td><td class="code-block-line-content"><span class="line">title: &quot;Page Title&quot;</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>3</span></td><td class="code-block-line-content"><span class="line">description: &quot;Subtitle (optional)&quot; </span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>4</span></td><td class="code-block-line-content"><span class="line">---</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>5</span></td><td class="code-block-line-content"><span class="line"></span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>6</span></td><td class="code-block-line-content"><span class="line">Hello world!</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div><div class="mb-6 mt-4 rounded-lg p-4 first:mt-0 callout-outlined-info"><div class="flex items-start space-x-3"><div class="mt-0.5 w-4"><svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon-md text-intent-info"><path d="M9.5 14.5L3 21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M5.00007 9.48528L14.1925 18.6777L15.8895 16.9806L15.4974 13.1944L21.0065 8.5211L15.1568 2.67141L10.4834 8.18034L6.69713 7.78823L5.00007 9.48528Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></div><div class="prose prose-sm dark:prose-invert -my-4 flex-1 overflow-x-auto before:mb-4 before:block after:mt-4 after:block"><div class="text-intent-info"><h5 class="leading-snug">Supported Syntax</h5><p>Fern supports <a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://github.github.com/gfm/">GitHub flavored Markdown (GFM)<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a> within MDX files, no plugin required.</p></div></div></div></div><p>In order for the Markdown page to show up, you’ll need to reference them from your <code>docs.yml</code> file. You can reference the Markdown page within a section or as a standalone page.</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>1</span></td><td class="code-block-line-content"><span class="line">navigation:</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>2</span></td><td class="code-block-line-content"><span class="line"> - page: &quot;Hello World&quot;</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>3</span></td><td class="code-block-line-content"><span class="line"> path: &quot;pages/hello-world.mdx&quot;</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>4</span></td><td class="code-block-line-content"><span class="line"> - section: Overview</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>5</span></td><td class="code-block-line-content"><span class="line"> content:</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>6</span></td><td class="code-block-line-content"><span class="line"> - page: QuickStart</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>7</span></td><td class="code-block-line-content"><span class="line"> path: pages/hello-world.mdx</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></div></details><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="add-an-api-reference"><summary type="button" aria-controls="radix-:Rdeel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:R5eel8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Add an API Reference</h6></summary><div data-state="closed" id="radix-:Rdeel8um:" role="region" aria-labelledby="radix-:R5eel8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>Add an API Reference by adding an OpenAPI Specification to your project.</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>$</span></td><td class="code-block-line-content"><span class="line">fern init --openapi /path/to/openapi.yml</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div><p>This will create an <code>openapi.yml</code> file in your project. You can reference this file in your <code>docs.yml</code> file by adding an api block.</p><div class="not-prose group/cb-container bg-card relative mb-6 mt-4 flex w-full rounded-lg border border-[var(--grayscale-a5)] shadow-sm"><pre class="code-block-root not-prose" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>1</span></td><td class="code-block-line-content"><span class="line">navigation:</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>2</span></td><td class="code-block-line-content"><span class="line"> - api: &quot;API Reference&quot;</span></td></tr></tbody></table></div></code></div></div></div></pre><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group fern-copy-button absolute z-20 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100 right-3 top-2 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div></div></details><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="brand-your-docs"><summary type="button" aria-controls="radix-:Rfeel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:R7eel8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Brand your docs</h6></summary><div data-state="closed" id="radix-:Rfeel8um:" role="region" aria-labelledby="radix-:R7eel8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>All of the branding for your docs can be configured in the <code>docs.yml</code> file.</p><p>For example, to set the logos, colors, and fonts for your docs, you can add the following to your <code>docs.yml</code> file:</p><div class="bg-card after:ring-card-border relative mb-6 mt-4 flex w-full min-w-0 max-w-full flex-col rounded-lg shadow-sm after:pointer-events-none after:absolute after:inset-0 after:rounded-[inherit] after:ring-1 after:ring-inset after:content-[&#x27;&#x27;] first:mt-0"><div class="bg-tag-default-soft rounded-t-[inherit]"><div class="shadow-border-default mx-px flex min-h-10 items-center justify-between shadow-[inset_0_-1px_0_0]"><div class="flex min-h-10 overflow-x-auto"><div class="flex items-center px-3 py-1.5"><span class="t-muted rounded text-sm font-semibold">docs.yml</span></div></div><button tabindex="0" data-state="closed" aria-disabled="false" class="fern-copy-button group ml-2 mr-1 fern-button minimal normal rounded square"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M19.4 20H9.6C9.26863 20 9 19.7314 9 19.4V9.6C9 9.26863 9.26863 9 9.6 9H19.4C19.7314 9 20 9.26863 20 9.6V19.4C20 19.7314 19.7314 20 19.4 20Z" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M15 9V4.6C15 4.26863 14.7314 4 14.4 4H4.6C4.26863 4 4 4.26863 4 4.6V14.4C4 14.7314 4.26863 15 4.6 15H9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></button></div></div><pre class="code-block-root not-prose rounded-b-[inherit]" tabindex="0"><div dir="ltr" class="fern-scroll-area" style="position:relative;--radix-scroll-area-corner-width:0px;--radix-scroll-area-corner-height:0px"><style>[data-radix-scroll-area-viewport]{scrollbar-width:none;-ms-overflow-style:none;-webkit-overflow-scrolling:touch;}[data-radix-scroll-area-viewport]::-webkit-scrollbar{display:none}</style><div data-radix-scroll-area-viewport="" class="fern-scroll-area-viewport" data-scrollbars="both" style="overflow-x:hidden;overflow-y:hidden;max-height:479px"><div style="min-width:100%;display:table"><code class="code-block text-sm"><div class="code-block-inner"><table class="code-block-line-group"><colgroup><col class="w-fit"/><col/></colgroup><tbody><tr class="code-block-line"><td class="code-block-line-gutter"><span>1</span></td><td class="code-block-line-content"><span class="line">colors:</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>2</span></td><td class="code-block-line-content"><span class="line"> accent-primary:</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>3</span></td><td class="code-block-line-content"><span class="line"> dark: &quot;#f0c193&quot;</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>4</span></td><td class="code-block-line-content"><span class="line"> light: &quot;#af5f1b&quot;</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>5</span></td><td class="code-block-line-content"><span class="line"></span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>6</span></td><td class="code-block-line-content"><span class="line">logo:</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>7</span></td><td class="code-block-line-content"><span class="line"> dark: ./docs/assets/logo-dark.svg</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>8</span></td><td class="code-block-line-content"><span class="line"> light: ./docs/assets/logo-light.svg</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>9</span></td><td class="code-block-line-content"><span class="line"> height: 40</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>10</span></td><td class="code-block-line-content"><span class="line"> href: https://buildwithfern.com/</span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>11</span></td><td class="code-block-line-content"><span class="line"></span></td></tr><tr class="code-block-line"><td class="code-block-line-gutter"><span>12</span></td><td class="code-block-line-content"><span class="line">favicon: ./docs/assets/favicon.png</span></td></tr></tbody></table></div></code></div></div></div></pre></div></div></div></details></div></div><div class="fern-step scroll-mt-content-padded" id="publish-to-production"><a class="fern-anchor" tabindex="-1" href="/learn/docs/getting-started/quickstart#publish-to-production"><span class="fern-anchor-icon"><span>3</span></span></a><h3>Publish to production</h3><div class="fern-accordion m-mdx" data-orientation="vertical"><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="host-on-a-custom-domain"><summary type="button" aria-controls="radix-:R2vel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:Rvel8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Host on a custom domain</h6></summary><div data-state="closed" id="radix-:R2vel8um:" role="region" aria-labelledby="radix-:Rvel8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>Fern supports hosting your docs website on a custom domain or on a custom subpath (e.g. <a class="fern-mdx-link" target="_blank" rel="noreferrer" href="https://domain.com/docs">https://domain.com/docs<svg width="1.5em" height="1.5em" viewBox="0 0 24 24" stroke-width="1.5" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="external-link-icon"><path d="M21 3L15 3M21 3L12 12M21 3V9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M21 13V19C21 20.1046 20.1046 21 19 21H5C3.89543 21 3 20.1046 3 19V5C3 3.89543 3.89543 3 5 3H11" stroke="currentColor" stroke-linecap="round"></path></svg></a>).</p><p>Please reach out to the Fern team at <a class="fern-mdx-link" href="mailto:support@buildwithfern.com">support@buildwithfern.com</a> to configure this.</p></div></div></details><details data-state="closed" data-orientation="vertical" class="fern-accordion-item scroll-mt-content-padded" id="configure-analytics"><summary type="button" aria-controls="radix-:R3fel8um:" aria-expanded="false" data-state="closed" data-orientation="vertical" id="radix-:R1fel8um:" class="fern-accordion-trigger" data-radix-collection-item=""><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-chevron-right fern-accordion-trigger-arrow"><path d="m9 18 6-6-6-6"></path></svg><h6 class="fern-accordion-trigger-title">Configure analytics</h6></summary><div data-state="closed" id="radix-:R3fel8um:" role="region" aria-labelledby="radix-:R1fel8um:" data-orientation="vertical" class="fern-accordion-content" style="--radix-accordion-content-height:var(--radix-collapsible-content-height);--radix-accordion-content-width:var(--radix-collapsible-content-width)"><div class="m-5"><p>Fern supports integrations with a variety of providers such as PostHog, Segment, Intercom, Google Tag Manager, etc. Find out more on this <a class="fern-mdx-link" href="/learn/docs/integrations/overview">page</a>.</p></div></div></details></div></div></div> <p>Below are some examples of documentation websites that have been published using Fern:</p> <div class="my-6 grid gap-4 first:mt-0 sm:gap-6 grid-cols-1 sm:grid-cols-2 xl:grid-cols-3"><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://dev.hume.ai/intro"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://www.hume.ai/icons/icon-144x144.png" alt="Hume logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">Hume</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://primer.io/docs/api"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://assets-global.website-files.com/65bcc4714739c54deeb9bac7/65d7663e0ceca67e8b5709c5_favicon.png" alt="Primer logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">Primer</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://www.assemblyai.com/docs/api-reference"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://www.assemblyai.com/favicon.png" alt="AssemblyAI logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">AssemblyAI</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://docs.superagent.sh/"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://framerusercontent.com/images/P75NaYul3IVsoMqx4RMALvngO4.png" alt="SuperAgent logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">SuperAgent</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://docs.multion.ai/"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://www.multion.ai/android-chrome-192x192.png" alt="MultiOn logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">MultiOn</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://docs.coactive.ai/"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://images.prismic.io/coactive/6d31b17f-cabb-492d-93ef-a9f42e03aaa2_coactive-logo-home.png?ixlib=gatsbyFP&amp;auto=compress%2Cformat&amp;fit=max" alt="Coactive logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">Coactive</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://help.getzep.com/"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://assets-global.website-files.com/660b1c076d13b7e2967a499d/660c6dc329d8b16a8468f5ba_Asset%2017.png" alt="Zep logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">Zep</div></div></div></a><a class="fern-card interactive not-prose relative block rounded-xl border p-6 text-base" target="_blank" rel="noreferrer" href="https://docs.rightbrain.ai/intro"><div class="flex items-start flex-col space-y-3"><span class="card-icon" style="width:32px;height:32px"><img src="https://fdr-prod-docs-files-public.s3.amazonaws.com/https://rightbrain.docs.buildwithfern.com/2024-08-05T10:16:06.892Z/docs/assets/Logo.png" alt="Rightbrain logo"/></span><div class="w-full space-y-1 overflow-hidden"><div class="t-default text-base font-semibold">Rightbrain</div></div></div></a></div></div><footer class="mt-12"><div class="flex gap-4 max-sm:flex-col sm:justify-between"><div><div><div class="flex w-full flex-wrap items-center justify-between gap-4"><div class="flex items-center justify-start gap-2"><span class="t-muted text-sm font-medium">Was this page helpful?</span><span class="fern-button-group"><button tabindex="0" data-state="closed" aria-disabled="false" data-selected="false" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:Rpat8um:" class="fern-button outlined normal"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class=""><path d="M16.4724 20H4.1C3.76863 20 3.5 19.7314 3.5 19.4V9.6C3.5 9.26863 3.76863 9 4.1 9H6.86762C7.57015 9 8.22116 8.6314 8.5826 8.02899L11.293 3.51161C11.8779 2.53688 13.2554 2.44422 13.9655 3.33186C14.3002 3.75025 14.4081 4.30635 14.2541 4.81956L13.2317 8.22759C13.1162 8.61256 13.4045 9 13.8064 9H18.3815C19.7002 9 20.658 10.254 20.311 11.5262L18.4019 18.5262C18.1646 19.3964 17.3743 20 16.4724 20Z" stroke="currentColor" stroke-linecap="round"></path><path d="M7 20L7 9" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="fern-button-text">Yes</span></span></button><button tabindex="0" data-state="closed" aria-disabled="false" data-selected="false" type="button" aria-haspopup="dialog" aria-expanded="false" aria-controls="radix-:R19at8um:" class="fern-button outlined normal"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class=""><path d="M16.4724 3.5H4.1C3.76863 3.5 3.5 3.76863 3.5 4.1V13.9C3.5 14.2314 3.76863 14.5 4.1 14.5H6.86762C7.57015 14.5 8.22116 14.8686 8.5826 15.471L11.293 19.9884C11.8779 20.9631 13.2554 21.0558 13.9655 20.1681C14.3002 19.7497 14.4081 19.1937 14.2541 18.6804L13.2317 15.2724C13.1162 14.8874 13.4045 14.5 13.8064 14.5H18.3815C19.7002 14.5 20.658 13.246 20.311 11.9738L18.4019 4.97376C18.1646 4.10364 17.3743 3.5 16.4724 3.5Z" stroke="currentColor" stroke-linecap="round"></path><path d="M7 14.5L7 3.5" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="fern-button-text">No</span></span></button></span></div></div></div></div><a tabindex="0" aria-disabled="false" data-state="off" class="fern-button outlined normal" target="_blank" rel="noreferrer" href="https://github.com/fern-api/fern/blob/main/fern/pages/docs/getting-started/quickstart.mdx?plain=1"><span class="fern-button-content"><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor"><path d="M3 21L12 21H21" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path><path d="M12.2218 5.82839L15.0503 2.99996L20 7.94971L17.1716 10.7781M12.2218 5.82839L6.61522 11.435C6.42769 11.6225 6.32233 11.8769 6.32233 12.1421L6.32233 16.6776L10.8579 16.6776C11.1231 16.6776 11.3774 16.5723 11.565 16.3847L17.1716 10.7781M12.2218 5.82839L17.1716 10.7781" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="fern-button-text">Edit this page</span></span></a></div><div class="not-prose grid grid-cols-1"><a class="fern-card interactive my-12 flex flex-1 items-center rounded-xl p-6" href="/learn/docs/getting-started/global-configuration"><div class="flex-1"><div class="text-base font-semibold">Global Configuration</div></div><span class="sm-4 t-muted sm:border-default inline-flex items-center gap-2 py-2.5 text-sm sm:ml-6 sm:border-l sm:pl-6"><span class="hidden leading-none sm:inline">Up Next</span><svg width="1.5em" height="1.5em" stroke-width="1.5" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" color="currentColor" class="size-icon"><path d="M9 6L15 12L9 18" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"></path></svg></span></a></div></footer><style> #builtwithfern { display: flex !important; opacity: 100% !important; } #builtwithfern * { display: initial !important; width: unset !important; opacity: 100% !important; } #builtwithfern, #builtwithfern * { visibility: initial !important; overflow: visible !important; position: relative !important; left: unset !important; top: unset !important; right: unset !important; bottom: unset !important; inset: unset !important; }</style><a id="builtwithfern" class="mx-auto flex items-baseline gap-1 mx-auto my-8 w-fit" href="https://buildwithfern.com/?utm_campaign=buildWith&amp;utm_medium=docs&amp;utm_source=buildwithfern.com" data-state="closed"><span class="t-muted whitespace-nowrap text-xs">Built with</span><svg viewBox="0 0 604 164" fill="none" xmlns="http://www.w3.org/2000/svg" class="transition" style="aspect-ratio:604/164;height:14px;margin-top:-2px"><path fill-rule="evenodd" clip-rule="evenodd" d="M295.294 0H255.861H255.836C234.047 0 221.437 11.4661 221.437 33.483V47.2372H193.242V75.2033H221.437V160.5H253.547V75.2033H288.404V47.2372H253.547V37.3728C253.547 30.7118 257.208 27.9661 263.87 27.9661H295.294V0ZM345.26 43.8081C311.777 43.8081 288.844 67.1979 288.844 103.198H288.87C288.87 139.884 311.802 163.96 346.43 163.96C375.311 163.96 392.727 149.291 399.388 126.816H366.591C363.591 133.02 356.955 137.367 346.633 137.367C331.277 137.367 321.87 129.562 320.497 115.35H400.761C401.219 110.545 401.447 106.401 401.447 102.283C401.447 66.2826 378.744 43.8081 345.26 43.8081ZM369.108 90.5877V91.0453H320.269C321.184 77.7487 329.675 69.0284 345.26 69.0284C360.845 69.0284 369.108 77.7487 369.108 90.5877ZM412.668 47.2321H440.863V67.1898C443.609 54.3508 452.787 47.2321 467.227 47.2321H487.414V51.122C487.414 64.4186 476.634 75.1982 463.338 75.1982C450.727 75.1982 444.753 81.6304 444.753 94.4694V160.52H412.642V47.2321H412.668ZM526.939 47.24H498.744H498.719V160.503H530.829V96.0789C530.829 81.6382 539.321 72.6891 552.16 72.6891C564.999 72.6891 571.889 80.0366 571.889 95.1637V160.528H604V91.7315C604 61.7061 586.559 43.8078 558.821 43.8078C545.753 43.8078 533.601 48.8417 526.939 58.7061V47.24Z" class="fill-grayscale-a10"></path><path d="M149.383 80.2222C138.594 71.101 122.341 67.4445 107.936 78.0925C107.273 78.5747 106.449 77.751 106.952 77.1081C110.367 72.7082 114.325 67.9668 117.519 63.2053C120.774 58.3233 125.636 54.8275 131.241 53.1198C161.076 44.079 152.116 0 152.116 0C152.116 0 106.027 2.97342 111.713 42.7329C112.657 49.3829 110.889 56.1535 106.731 61.4374C101.628 67.8865 95.7008 74.0543 91.4014 78.5144C90.4973 79.4386 88.9705 78.5546 89.3321 77.309C93.4909 63.3058 96.5246 41.648 82.1195 27.685L61.848 10.849L57.9504 15.9922C46.3581 31.2812 49.7534 52.8385 65.0625 64.4108C73.8422 71.0407 77.8201 78.2533 77.1973 86.169C76.8156 90.9104 74.6659 95.3505 71.4514 98.8663C65.4041 105.496 59.7586 112.608 55.3989 120.846C54.7962 121.991 53.0483 121.549 53.1086 120.243C53.7314 106.641 52.4255 75.983 29.5221 65.0336L3.88635 55.1289L1.89737 61.0556C-4.55174 80.182 5.99588 100.614 25.1021 107.104C41.7171 112.749 47.6439 123.457 43.6458 139.51C43.465 140.092 40.572 156.627 40.9738 163.96H59.3969C60.0198 152.589 71.9536 145.115 82.3003 149.756C85.2135 151.062 88.207 152.93 91.2809 155.341C107.755 168.32 132.025 165.246 144.983 148.752L148.68 144.05L125.375 127.315C109.383 114.738 88.0463 120.424 72.255 131.192C70.929 132.096 69.2414 130.65 69.9847 129.203C89.0709 91.7542 113.883 91.8346 123.607 100.152C135.4 110.238 153.261 108.429 163.266 96.5961L166.139 93.2007L149.363 80.2222H149.383Z" class="fill-grayscale-a10"></path></svg></a></article></main></div></div><footer id="fern-footer"></footer></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{"baseUrl":{"domain":"buildwithfern.com","basePath":"/learn"},"layout":{"pageWidth":{"type":"px","value":1504},"headerHeight":{"type":"px","value":75},"searchbarPlacement":"HEADER","tabsPlacement":"HEADER","contentAlignment":"CENTER","headerPosition":"FIXED","disableHeader":false},"title":"Fern","favicon":"1261be0f-f8e6-4b29-8ef8-520ca7575371","colors":{"light":{"accentPrimary":{"r":13,"g":76,"b":20,"a":1},"logo":"253da9e3-5315-4935-907d-b0b41b67b9a8","background":{"type":"solid","r":251,"g":255,"b":250,"a":1},"headerBackground":{"r":251,"g":255,"b":250,"a":1}},"dark":{"accentPrimary":{"r":43,"g":219,"b":60,"a":1},"logo":"23500dad-2049-44ec-9905-64724a4bcce5","background":{"type":"solid","r":8,"g":16,"b":8,"a":1},"headerBackground":{"r":8,"g":16,"b":8,"a":1}}},"js":{"remote":[{"url":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/js/koala.js"}]},"navbarLinks":[{"type":"minimal","href":"https://buildwithfern.com/slack","text":"Slack community"},{"type":"filled","href":"https://buildwithfern.com/contact","text":"Book a demo"}],"logo":{"height":30,"href":"https://www.buildwithfern.com","light":{"src":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/logo-primary.svg","width":1370,"height":480},"dark":{"src":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/logo-white.svg","width":1370,"height":480}},"content":{"slug":"learn/docs/getting-started/quickstart","title":{"engine":"next-mdx-remote","code":"\"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: \"Quickstart\"\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":{"authed":false,"tab":"Docs","slug":"learn/docs/getting-started/quickstart"},"jsxRefs":[]},"subtitle":{"engine":"next-mdx-remote","code":"\"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 beautiful documentation in under 5 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":{"authed":false,"tab":"Docs","slug":"learn/docs/getting-started/quickstart"},"jsxRefs":[]},"tableOfContents":[{"simpleString":"Initialize your fern folder","anchorString":"initialize-your-fern-folder","children":[]},{"simpleString":"Update your docs","anchorString":"update-your-docs","children":[]},{"simpleString":"Publish to production","anchorString":"publish-to-production","children":[]}],"content":{"engine":"next-mdx-remote","code":"\"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 p: \"p\",\n ..._provideComponents(),\n ...props.components\n }, {AccordionGroup, Card, CardGroup, CodeBlock, CodeBlocks, Image, Note, Step, StepGroup, Warning} = _components;\n if (!AccordionGroup) _missingMdxReference(\"AccordionGroup\", true);\n if (!Card) _missingMdxReference(\"Card\", true);\n if (!CardGroup) _missingMdxReference(\"CardGroup\", true);\n if (!CodeBlock) _missingMdxReference(\"CodeBlock\", true);\n if (!CodeBlocks) _missingMdxReference(\"CodeBlocks\", true);\n if (!Image) _missingMdxReference(\"Image\", true);\n if (!Note) _missingMdxReference(\"Note\", true);\n if (!Step) _missingMdxReference(\"Step\", true);\n if (!StepGroup) _missingMdxReference(\"StepGroup\", true);\n if (!Warning) _missingMdxReference(\"Warning\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(Image, {\n width: \"5504\",\n height: \"3226\",\n alt: \"Docs cascade\",\n src: \"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/pages/docs/getting-started/docs-cascade.png\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"With Fern, you can build beautiful developer documentation that matches your brand. Fern supports writing pages (written in Markdown) and generating API Reference documentation (from an OpenAPI Specification).\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"In this guide, we’ll show you how to get started with Fern in under 5 minutes.\"\n }), \"\\n\", _jsxs(StepGroup, {\n toc: true,\n children: [_jsxs(Step, {\n title: \"Initialize your fern folder\",\n id: \"initialize-your-fern-folder\",\n index: 1,\n children: [_jsxs(_components.p, {\n children: [\"All the configurations for your docs live in the \", _jsx(_components.code, {\n children: \"fern\"\n }), \" folder. Inside, you’ll\\nfind a \", _jsx(_components.code, {\n children: \"docs.yml\"\n }), \" file that contains all the settings for your documentation.\"]\n }), _jsx(AccordionGroup, {\n items: [{\n \"title\": \"Clone the starter repository\",\n \"id\": \"clone-the-starter-repository\",\n \"children\": _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Get started by cloning the \", _jsx(_components.a, {\n href: \"https://github.com/fern-api/docs-starter\",\n children: \"starter template\"\n }), \".\"]\n }), _jsx(CodeBlocks, {\n items: [{\n \"code\": \"git clone git@github.com:fern-api/docs-starter.git\\n\",\n \"language\": \"bash\",\n \"highlightLines\": [],\n \"highlightStyle\": \"highlight\",\n \"maxLines\": 20,\n \"title\": \"SSH\",\n \"wordWrap\": false,\n \"matchLanguage\": undefined\n }, {\n \"code\": \"git clone https://github.com/fern-api/docs-starter.git\\n\",\n \"language\": \"bash\",\n \"highlightLines\": [],\n \"highlightStyle\": \"highlight\",\n \"maxLines\": 20,\n \"title\": \"HTTPS\",\n \"wordWrap\": false,\n \"matchLanguage\": undefined\n }]\n }), _jsx(_components.p, {\n children: \"Next, please update the template settings to use your organization.\"\n }), _jsxs(Warning, {\n title: \"Edit template settings\",\n children: [_jsxs(_components.p, {\n children: [\"Please edit the details \", _jsx(_components.code, {\n children: \"fern.config.json\"\n }), \" and \", _jsx(_components.code, {\n children: \"docs.yml\"\n }), \" with your organization\\nname.\"]\n }), _jsx(CodeBlocks, {\n items: [{\n \"code\": \"{\\n \\\"organization\\\": \\\"{{YOUR_ORGANIZATION}}\\\",\\n \\\"version\\\": \\\"0.x.x\\\"\\n}\\n\",\n \"language\": \"json\",\n \"highlightLines\": [2],\n \"highlightStyle\": \"highlight\",\n \"maxLines\": 20,\n \"title\": \"fern.config.json\",\n \"wordWrap\": false,\n \"matchLanguage\": undefined\n }, {\n \"code\": \"instances:\\n - url: {{YOUR_ORGANIZATION}}.docs.buildwithfern.com\\n\",\n \"language\": \"yml\",\n \"highlightLines\": [2],\n \"highlightStyle\": \"highlight\",\n \"maxLines\": 20,\n \"title\": \"docs.yml\",\n \"wordWrap\": false,\n \"matchLanguage\": undefined\n }]\n })]\n }), _jsxs(_components.p, {\n children: [\"Finally, run \", _jsx(_components.code, {\n children: \"fern generate --docs\"\n }), \" to generate your documentation.\"]\n })]\n })\n }, {\n \"title\": \"Use the Fern CLI\",\n \"id\": \"use-the-fern-cli\",\n \"children\": _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"If you prefer, you can use our CLI to create a new project. Install the CLI\\nby running\"\n }), _jsx(CodeBlock, {\n code: \"npm install -g fern-api\\n\",\n language: \"bash\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n }), _jsx(_components.p, {\n children: \"Then run\"\n }), _jsx(CodeBlock, {\n code: \"fern init --docs\\n\",\n language: \"bash\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n }), _jsxs(_components.p, {\n children: [\"You will see a new \", _jsx(_components.code, {\n children: \"fern\"\n }), \" folder in your project with the following structure:\"]\n }), _jsx(CodeBlock, {\n code: \" fern\\n ├─ docs.yml\\n └─ fern.config.json\\n\",\n language: \"bash\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n }), _jsxs(_components.p, {\n children: [\"Finally, run \", _jsx(_components.code, {\n children: \"fern generate --docs\"\n }), \" to generate your documentation.\"]\n })]\n })\n }],\n toc: true\n })]\n }), _jsxs(Step, {\n title: \"Update your docs\",\n id: \"update-your-docs\",\n index: 2,\n children: [_jsx(Note, {\n children: _jsxs(_components.p, {\n children: [\"We provide a white-glove migration service as part of our Enterprise plan. Interested? Request it\\n\", _jsx(_components.a, {\n href: \"https://buildwithfern.com/contact\",\n children: \"here\"\n }), \".\"]\n })\n }), _jsx(AccordionGroup, {\n items: [{\n \"title\": \"Add content\",\n \"id\": \"add-content\",\n \"children\": _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Add content with MDX files.\"\n }), _jsx(CodeBlock, {\n code: \"---\\ntitle: \\\"Page Title\\\"\\ndescription: \\\"Subtitle (optional)\\\" \\n---\\n\\nHello world!\\n\",\n language: \"markdown\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n }), _jsx(Note, {\n title: \"Supported Syntax\",\n children: _jsxs(_components.p, {\n children: [\"Fern supports \", _jsx(_components.a, {\n href: \"https://github.github.com/gfm/\",\n children: \"GitHub flavored Markdown (GFM)\"\n }), \" within MDX files, no plugin required.\"]\n })\n }), _jsxs(_components.p, {\n children: [\"In order for the Markdown page to show up, you’ll need to reference them from your \", _jsx(_components.code, {\n children: \"docs.yml\"\n }), \" file. You\\ncan reference the Markdown page within a section or as a standalone page.\"]\n }), _jsx(CodeBlock, {\n code: \"navigation:\\n - page: \\\"Hello World\\\"\\n path: \\\"pages/hello-world.mdx\\\"\\n - section: Overview\\n content:\\n - page: QuickStart\\n path: pages/hello-world.mdx\\n\",\n language: \"yml\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n })]\n })\n }, {\n \"title\": \"Add an API Reference\",\n \"id\": \"add-an-api-reference\",\n \"children\": _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Add an API Reference by adding an OpenAPI Specification to your project.\"\n }), _jsx(CodeBlock, {\n code: \"fern init --openapi /path/to/openapi.yml\\n\",\n language: \"bash\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n }), _jsxs(_components.p, {\n children: [\"This will create an \", _jsx(_components.code, {\n children: \"openapi.yml\"\n }), \" file in your project. You can reference this file in your\\n\", _jsx(_components.code, {\n children: \"docs.yml\"\n }), \" file by adding an api block.\"]\n }), _jsx(CodeBlock, {\n code: \"navigation:\\n - api: \\\"API Reference\\\"\\n\",\n language: \"yml\",\n highlightLines: [],\n highlightStyle: \"highlight\",\n maxLines: 20,\n wordWrap: false,\n matchLanguage: true\n })]\n })\n }, {\n \"title\": \"Brand your docs\",\n \"id\": \"brand-your-docs\",\n \"children\": _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"All of the branding for your docs can be configured in the \", _jsx(_components.code, {\n children: \"docs.yml\"\n }), \" file.\"]\n }), _jsxs(_components.p, {\n children: [\"For example, to set the logos, colors, and fonts for your docs, you can\\nadd the following to your \", _jsx(_components.code, {\n children: \"docs.yml\"\n }), \" file:\"]\n }), _jsx(CodeBlocks, {\n items: [{\n \"code\": \"colors:\\n accent-primary:\\n dark: \\\"#f0c193\\\"\\n light: \\\"#af5f1b\\\"\\n\\nlogo:\\n dark: ./docs/assets/logo-dark.svg\\n light: ./docs/assets/logo-light.svg\\n height: 40\\n href: https://buildwithfern.com/\\n\\nfavicon: ./docs/assets/favicon.png\\n\",\n \"language\": \"yml\",\n \"highlightLines\": [],\n \"highlightStyle\": \"highlight\",\n \"maxLines\": 20,\n \"title\": \"docs.yml\",\n \"wordWrap\": false,\n \"matchLanguage\": undefined\n }]\n })]\n })\n }],\n toc: true\n })]\n }), _jsx(Step, {\n title: \"Publish to production\",\n id: \"publish-to-production\",\n index: 3,\n children: _jsx(AccordionGroup, {\n items: [{\n \"title\": \"Host on a custom domain\",\n \"id\": \"host-on-a-custom-domain\",\n \"children\": _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Fern supports hosting your docs website on a custom domain or on a\\ncustom subpath (e.g. \", _jsx(_components.a, {\n href: \"https://domain.com/docs\",\n children: \"https://domain.com/docs\"\n }), \").\"]\n }), _jsxs(_components.p, {\n children: [\"Please reach out to the Fern team at \", _jsx(_components.a, {\n href: \"mailto:support@buildwithfern.com\",\n children: \"support@buildwithfern.com\"\n }), \" to configure this.\"]\n })]\n })\n }, {\n \"title\": \"Configure analytics\",\n \"id\": \"configure-analytics\",\n \"children\": _jsx(_Fragment, {\n children: _jsxs(_components.p, {\n children: [\"Fern supports integrations with a variety of providers such as PostHog, Segment, Intercom,\\nGoogle Tag Manager, etc.\\nFind out more on this \", _jsx(_components.a, {\n href: \"/learn/docs/integrations/overview\",\n children: \"page\"\n }), \".\"]\n })\n })\n }],\n toc: true\n })\n })]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Below are some examples of documentation websites that have been published using Fern:\"\n }), \"\\n\", _jsxs(CardGroup, {\n cols: 3,\n children: [_jsx(Card, {\n title: \"Hume\",\n href: \"https://dev.hume.ai/intro\",\n icon: _jsx(_components.img, {\n src: \"https://www.hume.ai/icons/icon-144x144.png\",\n alt: \"Hume logo\"\n })\n }), _jsx(Card, {\n title: \"Primer\",\n href: \"https://primer.io/docs/api\",\n icon: _jsx(_components.img, {\n src: \"https://assets-global.website-files.com/65bcc4714739c54deeb9bac7/65d7663e0ceca67e8b5709c5_favicon.png\",\n alt: \"Primer logo\"\n })\n }), _jsx(Card, {\n title: \"AssemblyAI\",\n href: \"https://www.assemblyai.com/docs/api-reference\",\n icon: _jsx(_components.img, {\n src: \"https://www.assemblyai.com/favicon.png\",\n alt: \"AssemblyAI logo\"\n })\n }), _jsx(Card, {\n title: \"SuperAgent\",\n href: \"https://docs.superagent.sh/\",\n icon: _jsx(_components.img, {\n src: \"https://framerusercontent.com/images/P75NaYul3IVsoMqx4RMALvngO4.png\",\n alt: \"SuperAgent logo\"\n })\n }), _jsx(Card, {\n title: \"MultiOn\",\n href: \"https://docs.multion.ai/\",\n icon: _jsx(_components.img, {\n src: \"https://www.multion.ai/android-chrome-192x192.png\",\n alt: \"MultiOn logo\"\n })\n }), _jsx(Card, {\n title: \"Coactive\",\n href: \"https://docs.coactive.ai/\",\n icon: _jsx(_components.img, {\n src: \"https://images.prismic.io/coactive/6d31b17f-cabb-492d-93ef-a9f42e03aaa2_coactive-logo-home.png?ixlib=gatsbyFP\u0026auto=compress%2Cformat\u0026fit=max\",\n alt: \"Coactive logo\"\n })\n }), _jsx(Card, {\n title: \"Zep\",\n href: \"https://help.getzep.com/\",\n icon: _jsx(_components.img, {\n src: \"https://assets-global.website-files.com/660b1c076d13b7e2967a499d/660c6dc329d8b16a8468f5ba_Asset%2017.png\",\n alt: \"Zep logo\"\n })\n }), _jsx(Card, {\n title: \"Rightbrain\",\n href: \"https://docs.rightbrain.ai/intro\",\n icon: _jsx(_components.img, {\n src: \"https://fdr-prod-docs-files-public.s3.amazonaws.com/https://rightbrain.docs.buildwithfern.com/2024-08-05T10:16:06.892Z/docs/assets/Logo.png\",\n alt: \"Rightbrain logo\"\n })\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":{"title":"Quickstart","subtitle":"Start building beautiful documentation in under 5 minutes","edit-this-page-url":"https://github.com/fern-api/fern/blob/main/fern/pages/docs/getting-started/quickstart.mdx?plain=1"},"scope":{"authed":false,"tab":"Docs","slug":"learn/docs/getting-started/quickstart"},"jsxRefs":["Steps","AccordionGroup","Accordion","CodeBlocks","Warning","CodeBlock","Note","CardGroup","Card"]},"breadcrumb":[{"title":"Getting Started","pointsTo":"learn/docs/getting-started/overview"}],"neighbors":{"prev":{"slug":"learn/docs/getting-started/customer-showcase","title":"Docs Customer Showcase"},"next":{"slug":"learn/docs/getting-started/global-configuration","title":"Global Configuration"}},"hasAside":false,"type":"markdown-page","apis":{},"endpointIdsToSlugs":{}},"navigation":{"currentTabIndex":3,"tabs":[{"type":"tabGroup","title":"Home","icon":"fa-regular fa-home","index":0,"slug":"learn"},{"type":"tabGroup","title":"API Definition","icon":"fa-regular fa-book","index":1,"slug":"learn/api-definition","pointsTo":"learn/api-definition/introduction/what-is-an-api-definition"},{"type":"tabGroup","title":"SDKs","icon":"fa-brands fa-codepen","index":2,"slug":"learn/sdks","pointsTo":"learn/sdks/introduction/overview"},{"type":"tabGroup","title":"Docs","icon":"fa-regular fa-browser","index":3,"slug":"learn/docs","pointsTo":"learn/docs/getting-started/overview"},{"type":"tabGroup","title":"CLI \u0026 API Reference","icon":"fa-regular fa-code","index":4,"slug":"learn","pointsTo":"learn/cli-reference/overview"}],"versions":[],"sidebar":{"type":"sidebarRoot","id":"775bc25d8042f58fab2e8b23adc028d4920b7cf63c1e049ce99cc538190c95fd","children":[{"type":"section","id":"6bf5cb435a4bd0b2632e950ca9009afd20137be1190c1e1997a29023320a3e78","children":[{"type":"page","id":"fcc534cbb0efb1d1e139b589c9337e1fbb707e72a25f8e2f4963eac94619ea06","title":"Overview","slug":"learn/docs/getting-started/overview","icon":"fa-regular fa-book-open","pageId":"pages/docs/getting-started/docs-overview.mdx"},{"type":"page","id":"b23ee63f872140fb7c98fefaa67d0b10cd6b1a5504a857d7cccbad1a8e92194f","title":"Docs Customer Showcase","slug":"learn/docs/getting-started/customer-showcase","icon":"fa-regular fa-star","pageId":"pages/docs/getting-started/customer-showcase.mdx"},{"type":"page","id":"45819c026293ce85a1538aac218821ca0358fd2bf1b185acda289d09891cb90a","title":"Quickstart","slug":"learn/docs/getting-started/quickstart","icon":"fa-regular fa-bolt","pageId":"pages/docs/getting-started/quickstart.mdx"},{"type":"page","id":"209b2c58628296d08257ae1e5751d43f42937427f85b3c31a58aa29e97421d53","title":"Global Configuration","slug":"learn/docs/getting-started/global-configuration","icon":"fa-regular fa-gear","pageId":"pages/docs/getting-started/global-configuration.mdx"},{"type":"page","id":"587ec83bc6bca723d6f9a69d6595fd771e6b8edc1e0d644029c9b9f873f3deba","title":"Project Structure","slug":"learn/docs/getting-started/project-structure","icon":"fa-regular fa-diagram-project","pageId":"pages/docs/getting-started/project-structure.mdx"},{"type":"page","id":"cd4cf2a26b76f54c27952a5ac4e729eedc22ce496941bab61c3bee661342c926","title":"Preview your Docs","slug":"learn/docs/getting-started/development","icon":"fa-regular fa-desktop","pageId":"pages/docs/getting-started/development.mdx"},{"type":"page","id":"43044f2509c22dab618db54a75932702324dc1cf0e9c58307dbb1ef22e6e91a6","title":"Publish your Docs","slug":"learn/docs/getting-started/publish-your-docs","icon":"fa-regular fa-cloud-arrow-up","pageId":"pages/docs/getting-started/publishing-your-docs.mdx"},{"type":"changelog","id":"3ba90086287914d5ad57b5258fd838eaa9bc048e1063fc5045a9fd15e9c11350","children":[{"type":"changelogYear","id":"7ba6ff86237f0032d4fb83c044e4388c78c09e628dc55f48bb7d41eaf2981c35","children":[{"type":"changelogMonth","id":"8a7df5ba8c72176060cd4884f116b35ce906b34f7825a1f885154e9d7270a592","children":[{"type":"changelogEntry","id":"3c96ea882a92fd94469aa46afe047103ebd14692b86842762e425ee62b89b45f","title":"February 4, 2025","slug":"learn/docs/getting-started/changelog/2025/2/4","date":"2025-02-04T00:00:00.000Z","pageId":"pages/changelogs/docs/2025-02-04.mdx"}],"title":"February 1900","slug":"learn/docs/getting-started/changelog/2","month":2},{"type":"changelogMonth","id":"2f5f608095ecffea89f93476f554fb6c5228f805203b2b2b177d011fada698e7","children":[{"type":"changelogEntry","id":"80a0e71cc8d881364d3d59c7d6ed9bdefe72b860c25ccf02c805a5b905b4a5fb","title":"January 21, 2025","slug":"learn/docs/getting-started/changelog/2025/1/21","date":"2025-01-21T00:00:00.000Z","pageId":"pages/changelogs/docs/2025-01-21.mdx"},{"type":"changelogEntry","id":"d0a3485fc253fedeb40ed2320d151a17202565ef118847ed955bc295198c26a6","title":"January 14, 2025","slug":"learn/docs/getting-started/changelog/2025/1/14","date":"2025-01-14T00:00:00.000Z","pageId":"pages/changelogs/docs/2025-01-14.mdx"}],"title":"January 1900","slug":"learn/docs/getting-started/changelog/1","month":1}],"title":"2025","slug":"learn/docs/getting-started/changelog/2025","year":2025},{"type":"changelogYear","id":"f5f17e1d6d37292a1506ec358460ebe7530d5b22d2a73f46af0dd45129c397d1","children":[{"type":"changelogMonth","id":"6c7fb7561d9027047d0332aa3ac23962e99b87878a120043fa7db0759aaf71a9","children":[{"type":"changelogEntry","id":"4e428d9687e45af22f52e9393977e6b1c8ef0fc501567a67a6f9fa974696fcf3","title":"December 30, 2024","slug":"learn/docs/getting-started/changelog/2024/12/30","date":"2024-12-30T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-12-30.mdx"}],"title":"December 1900","slug":"learn/docs/getting-started/changelog/12","month":12},{"type":"changelogMonth","id":"12866647ebbb80b7ec8af8d5019359fd9984fd991dad70f0fe8b7d8497b9f2d1","children":[{"type":"changelogEntry","id":"1d70a60637394e266f271367b5215a866710a9347d088597b34acd25f78b90f9","title":"November 27, 2024","slug":"learn/docs/getting-started/changelog/2024/11/27","date":"2024-11-27T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-11-27.mdx"}],"title":"November 1900","slug":"learn/docs/getting-started/changelog/11","month":11},{"type":"changelogMonth","id":"02b1497fee25eeca13afbef59564ac916691e31be9d05ba295649f6904c50cd9","children":[{"type":"changelogEntry","id":"2f4c76fe275797d4e77cded4f1342ab715e5050843af4650e06785434d75dc43","title":"October 31, 2024","slug":"learn/docs/getting-started/changelog/2024/10/31","date":"2024-10-31T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-10-31.mdx"}],"title":"October 1900","slug":"learn/docs/getting-started/changelog/10","month":10},{"type":"changelogMonth","id":"be2cf13e43464c7dfceb6b0683183134e98aa288f0fbc16cbe5a917addf6439a","children":[{"type":"changelogEntry","id":"2884968dec69a315401056ac1330583508a276eee748019ecbc6172e4c2274a7","title":"September 24, 2024","slug":"learn/docs/getting-started/changelog/2024/9/24","date":"2024-09-24T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-09-24.mdx"}],"title":"September 1900","slug":"learn/docs/getting-started/changelog/9","month":9},{"type":"changelogMonth","id":"b87f7f9eda02628e9cdd8458741d04e9ff99a6efa2aba426a7bf37fd31a9ffbf","children":[{"type":"changelogEntry","id":"c172bbfa5313a7065bda6663b2cdc359074b565391e57f132c9b50f815a0da08","title":"August 20, 2024","slug":"learn/docs/getting-started/changelog/2024/8/20","date":"2024-08-20T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-08-20.mdx"}],"title":"August 1900","slug":"learn/docs/getting-started/changelog/8","month":8},{"type":"changelogMonth","id":"629550e64925e53d1cbec534d9c388e0bca230b9eeb417e00b057dbaaff6324f","children":[{"type":"changelogEntry","id":"c5b04153daf6c1434df0e61395f34725b1a33bf1a7ee4239c705af075aff64c1","title":"July 30, 2024","slug":"learn/docs/getting-started/changelog/2024/7/30","date":"2024-07-30T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-07-30.mdx"}],"title":"July 1900","slug":"learn/docs/getting-started/changelog/7","month":7},{"type":"changelogMonth","id":"16971258666f6a67ecaca106802e506acfd8df1525eb14145cc417240982d078","children":[{"type":"changelogEntry","id":"e5f6171afdaa0862c4103693f0df99a6a670adca4fb45a6a60faf1c68a1dfc6f","title":"June 25, 2024","slug":"learn/docs/getting-started/changelog/2024/6/25","date":"2024-06-25T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-06-25.mdx"}],"title":"June 1900","slug":"learn/docs/getting-started/changelog/6","month":6},{"type":"changelogMonth","id":"4fd035bb4a488bccf4c61b4733f7a446cfcfd37186f14badd075d3efdb74bc1d","children":[{"type":"changelogEntry","id":"12bd96909c866abef9473b8c4f06183bc26d7e123973bdc903d58ef7fb2a78f7","title":"May 22, 2024","slug":"learn/docs/getting-started/changelog/2024/5/22","date":"2024-05-22T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-05-22.mdx"}],"title":"May 1900","slug":"learn/docs/getting-started/changelog/5","month":5},{"type":"changelogMonth","id":"f2d06a36e635d63bc34b7583c0335c1de0c6c1e25c51826db1d47f29d98c1520","children":[{"type":"changelogEntry","id":"287ef931be9189c6b334bff153e76114440fe1c7162b7375df706ed2d84b686f","title":"April 20, 2024","slug":"learn/docs/getting-started/changelog/2024/4/20","date":"2024-04-20T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-04-20.mdx"}],"title":"April 1900","slug":"learn/docs/getting-started/changelog/4","month":4},{"type":"changelogMonth","id":"55fbf529668880a33c08d2be7b4ad05e5f8c797d4d82dddc4ed4eb29176b0292","children":[{"type":"changelogEntry","id":"8b156fe2cd74d00ebd2b264586d1e844d0cc640c8250a7744ab111cd4c5bc3c2","title":"March 24, 2024","slug":"learn/docs/getting-started/changelog/2024/3/24","date":"2024-03-24T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-03-24.mdx"}],"title":"March 1900","slug":"learn/docs/getting-started/changelog/3","month":3},{"type":"changelogMonth","id":"90b0417fed8cad1413b11b6110ea2bc25663ce1c495fef5d947396a50c98e889","children":[{"type":"changelogEntry","id":"7f4535f170c92c4da2216967f705f81e17a8d933ba68ccb08c2703082a47a4dc","title":"February 22, 2024","slug":"learn/docs/getting-started/changelog/2024/2/22","date":"2024-02-22T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-02-22.mdx"}],"title":"February 1900","slug":"learn/docs/getting-started/changelog/2","month":2},{"type":"changelogMonth","id":"815324399c52d84d8233b8ef833bfeca1be4ad2ab957734a2ee131b478e42399","children":[{"type":"changelogEntry","id":"6b363405ba44944179b4c34283d83884fdb72a9a9c65e4fab9907803c82d2cff","title":"January 24, 2024","slug":"learn/docs/getting-started/changelog/2024/1/24","date":"2024-01-24T00:00:00.000Z","pageId":"pages/changelogs/docs/2024-01-24.mdx"}],"title":"January 1900","slug":"learn/docs/getting-started/changelog/1","month":1}],"title":"2024","slug":"learn/docs/getting-started/changelog/2024","year":2024}],"title":"Changelog","slug":"learn/docs/getting-started/changelog","hidden":false}],"title":"Getting Started","slug":"learn/docs/getting-started","pointsTo":"learn/docs/getting-started/overview"},{"type":"section","id":"8d4a659d4efc06b58766a32a500840c3aaf2bfa4c3d514751327b21d7b2f0b7d","children":[{"type":"page","id":"b41a4f8474e49b484473c761e642a4f40ec424e68bb48c21b1db745e3c33dd24","title":"Navigation","slug":"learn/docs/building-and-customizing-your-docs/navigation","icon":"fa-regular fa-map-signs","pageId":"pages/docs/building-your-docs/navigation.mdx"},{"type":"page","id":"589b088317be8a10912cb5078b23bba37a848652f55558b3c3f4f3c7730772c3","title":"Versioning","slug":"learn/docs/building-and-customizing-your-docs/versioning","icon":"fa-regular fa-code-branch","pageId":"pages/docs/building-your-docs/versioning.mdx"},{"type":"page","id":"1d61d0f2d9c14df726cb84d743e81aad1ae1540d90eb64879207513f1b9cb32d","title":"Announcement Banner","slug":"learn/docs/building-and-customizing-your-docs/announcements","icon":"fa-regular fa-bullhorn","pageId":"pages/docs/building-your-docs/announcement-banner.mdx"},{"type":"page","id":"89571d6c97399c34df41c7b7eddb4f964763e2daaa033e5a894309aecf9768b4","title":"Links and Redirects","slug":"learn/docs/building-and-customizing-your-docs/links-and-redirects","icon":"fa-regular fa-link","pageId":"pages/docs/building-your-docs/links-and-redirects.mdx"},{"type":"page","id":"847d26fbbbf488f4fafc008335d1ac89be68f50574e09def1fd3e82587185edc","title":"Customizing Slugs","slug":"learn/docs/building-and-customizing-your-docs/customizing-slugs","icon":"fa-regular fa-pen-to-square","pageId":"pages/docs/building-your-docs/customizing-slugs.mdx"},{"type":"page","id":"bc0cf461fd62d2297f2c07c3dace97801aab5f758350d0d46f2478251364ffb7","title":"Hiding Content","slug":"learn/docs/building-and-customizing-your-docs/hiding-content","icon":"fa-regular fa-eye-slash","pageId":"pages/docs/building-your-docs/hiding-content.mdx"},{"type":"page","id":"5e54808757c88ae22e5ad1c4768e2d17728f1b28ccb226bf325ab4018936354e","title":"Custom CSS \u0026 Global JS","slug":"learn/docs/building-and-customizing-your-docs/custom-css-global-js","icon":"fa-regular fa-palette","pageId":"pages/docs/building-your-docs/custom-css-js.mdx"},{"type":"page","id":"d50da85969d7be4f2b55ee4d7843b2c5ee973f708b055d6feb86b1906531805c","title":"Pull Request Preview","slug":"learn/docs/building-and-customizing-your-docs/pull-request-preview","icon":"fa-regular fa-magnifying-glass","pageId":"pages/docs/building-your-docs/pr-preview.mdx"},{"type":"page","id":"e2dad8a25413349987df55f3a4a4a49be6b2b299bbb0cf10ba562427208d9db1","title":"Custom Domain","slug":"learn/docs/building-and-customizing-your-docs/custom-domain","icon":"fa-regular fa-globe","pageId":"pages/docs/building-your-docs/custom-domain.mdx"},{"type":"page","id":"183587214b6f14eae5bfad391bfe3b5c825f9e74f5d63cd3170b6f102cbbe0d4","title":"Edit This Page and User Feedback","slug":"learn/user-feedback","icon":"fa-regular fa-comment-dots","pageId":"pages/docs/building-your-docs/user-feedback.mdx"},{"type":"page","id":"a86d2144e8815b2a57daf20713319ae91a8b1f191789f6ce334ea3028c559423","title":"Role based access control (RBAC)","slug":"learn/docs/building-and-customizing-your-docs/rbac","icon":"fa-regular fa-lock","pageId":"pages/docs/building-your-docs/rbac.mdx"}],"title":"Building and Customizing Your Docs","slug":"learn/docs/building-and-customizing-your-docs","pointsTo":"learn/docs/building-and-customizing-your-docs/navigation"},{"type":"section","id":"520f49a0ec877dc2da275534e37b6337f03b71c1b60f4ddb52da52bb46aa8256","children":[{"type":"page","id":"8babe45782060a89e0fcdc3b0e282089cbce4a682780a3a7caeceab66cbac732","title":"Write Markdown Content","slug":"learn/docs/content/write-markdown","icon":"fa-regular fa-font","pageId":"pages/docs/writing-content/write-markdown.mdx"},{"type":"section","id":"e0093d6824f784705c2dc3c32bb59ff5ad3eb2fb8b0d45d1adc0f516c66f9665","children":[{"type":"page","id":"fa84a25305daf087ed38c0ba3b52b1bd6e16ea73e7189e5908b0b42eede88d18","title":"Overview","slug":"learn/docs/content/components/overview","icon":"fa-regular fa-wrench","pageId":"pages/docs/components/overview.mdx"},{"type":"page","id":"d45c9674deb26bb666435b1e024c04525ed0ad1fefe35cc2cb298875dc9e85d2","title":"Accordions","slug":"learn/docs/content/components/accordions","icon":"fa-regular fa-angle-down","pageId":"pages/docs/components/accordions.mdx"},{"type":"page","id":"ee0c3a0a56a3a0b60c5d4e9b33c8ac1af00bd2c29e758199ba9da9a7091595af","title":"Accordion Groups","slug":"learn/docs/content/components/accordion-groups","icon":"fa-regular fa-layer-group","pageId":"pages/docs/components/accordion-groups.mdx"},{"type":"page","id":"a6259691924a90cbe8a4324eb90ef23c984a0938e1459b98615c99ea419a05d4","title":"Aside","slug":"learn/docs/content/components/aside","icon":"fa-regular fa-align-right","pageId":"pages/docs/components/asides.mdx"},{"type":"page","id":"8fe25faf952cd9aba3178e3bcacc4fd23f5c5bb282effc7fe3633bd54ebcb3c5","title":"Callouts","slug":"learn/docs/content/components/callouts","icon":"fa-regular fa-circle-exclamation","pageId":"pages/docs/components/callouts.mdx"},{"type":"page","id":"cd5268a7c98b742cd275b1451cf1516cc10941704f7f9fc4e667337ec5b7c5cf","title":"Cards","slug":"learn/docs/content/components/cards","icon":"fa-regular fa-square","pageId":"pages/docs/components/cards.mdx"},{"type":"page","id":"251ae3575e2de3e5fec70e9bba4277a6a50d459859088289875c14498b784e4c","title":"Card Groups","slug":"learn/docs/content/components/card-groups","icon":"fa-regular fa-table-cells-large","pageId":"pages/docs/components/card-groups.mdx"},{"type":"page","id":"01e8545a9ac8591ca78f597b4d4970d93b88b34cc675ce839e5c608318288de8","title":"Code Blocks","slug":"learn/docs/content/components/code-blocks","icon":"fa-regular fa-code","pageId":"pages/docs/components/code-blocks.mdx"},{"type":"page","id":"fb2a1707652fd93c62e8bec056e989dcbdde8c28646be9734d1b881e8cf958b4","title":"Embed","slug":"learn/docs/content/components/embed","icon":"fa-regular fa-window-maximize","pageId":"pages/docs/components/embed.mdx"},{"type":"page","id":"85acc6fba8766ce31c1ebac8065f41b2078f16552abba005337a86f1b57b60d4","title":"Endpoint Request Snippet","slug":"learn/docs/content/components/request-snippet","icon":"fa-regular fa-arrow-up-right-from-square","pageId":"pages/docs/components/endpoint-request-snippet.mdx"},{"type":"page","id":"71b4527255ff2a14074f6281e5a1602773200f862228182d748c7af84b92fcc9","title":"Endpoint Response Snippet","slug":"learn/docs/content/components/response-snippet","icon":"fa-regular fa-arrow-down","pageId":"pages/docs/components/endpoint-response-snippet.mdx"},{"type":"page","id":"7db1d6dd618d333c97388d7600229b19eb6ad55a45d860d1e2e8db7bb8f2255f","title":"Frames","slug":"learn/docs/content/components/frames","icon":"fa-regular fa-border-all","pageId":"pages/docs/components/frames.mdx"},{"type":"page","id":"5c3b4e46354490bcfd3743a6fad738ac437c089bea0c6df42daaf70b71acb64f","title":"Icons","slug":"learn/docs/content/components/icons","icon":"fa-regular fa-icons","pageId":"pages/docs/components/icons.mdx"},{"type":"page","id":"aed08de7e499889ca9864574c274fc7c92ac61a2a8104bf34ef6673fae3f2f65","title":"Parameter Fields","slug":"learn/docs/content/components/paramfield","icon":"fa-regular fa-input-text","pageId":"pages/docs/components/paramfield.mdx"},{"type":"page","id":"23e31cc8df08adff432a78ce8d4a3d92f87e95d893d85898557420c6d9daacf2","title":"Steps","slug":"learn/docs/content/components/steps","icon":"fa-regular fa-list-ol","pageId":"pages/docs/components/steps.mdx"},{"type":"page","id":"e8d8c0427f6872825d5db7429f0cc706ea21bf877b2a032cc4e7e1e47ff8b9cf","title":"Tabs","slug":"learn/docs/content/components/tabs","icon":"fa-regular fa-window-restore","pageId":"pages/docs/components/tabs.mdx"}],"title":"Components","slug":"learn/docs/content/components","icon":"fa-regular fa-puzzle-piece","pointsTo":"learn/docs/content/components/overview"},{"type":"page","id":"6f5f3487e0ad529ff22c06fe7f65b472fe2ccd167be68ed909c3edfa87069c46","title":"Frontmatter","slug":"learn/docs/content/frontmatter","icon":"fa-regular fa-sliders","pageId":"pages/docs/writing-content/frontmatter.mdx"},{"type":"page","id":"347deef419984504c379b11aa74b093a7666b0b3980f411ebc13c8d67e888dae","title":"Reusable Snippets","slug":"learn/docs/content/reusable-snippets","icon":"fa-regular fa-recycle","pageId":"pages/docs/writing-content/reusable-snippets.mdx"},{"type":"page","id":"e0a13f0c7bf9050b1a98a40a18bb17b0ac01632af9e31d81d33592d319d813ab","title":"Changelog","slug":"learn/docs/content/changelog","icon":"fa-regular fa-clock-rotate-left","pageId":"pages/docs/writing-content/changelog.mdx"}],"title":"Writing Content","slug":"learn/docs/content","pointsTo":"learn/docs/content/write-markdown"},{"type":"section","id":"66931c9352265a77b36fb98a6fca785737da7ac871272179e2165fdcda871269","children":[{"type":"page","id":"e66a22646dc45dca8f7010dad462ae0059b4466db98469fb3203ac9db0dc7db0","title":"Generate API Reference","slug":"learn/docs/api-references/generate-api-ref","icon":"fa-regular fa-wand-sparkles","pageId":"pages/docs/api-references/generate-api-ref.mdx"},{"type":"page","id":"315df6c70072f1362c6732dd9effdb10e6ae6f00f7254b36ce1ea75b7cb4dee3","title":"SDK Snippets","slug":"learn/docs/api-references/sdk-snippets","icon":"fa-regular fa-brackets-curly","pageId":"pages/docs/api-references/sdk-snippets.mdx"},{"type":"page","id":"871fb45b173586d03eb7e32501b2c88534afc74e941e080db3b06d81910dd630","title":"HTTP Snippets","slug":"learn/docs/api-references/http-snippets","icon":"fa-regular fa-code","pageId":"pages/docs/api-references/http-snippets.mdx"},{"type":"section","id":"7c26e10bb0f6ed77a318408a4092330441c0c76fc6bf6ef56a5eb6b9324de369","children":[{"type":"page","id":"bab8d43ddc69680d7c09354a621bc3e66023b5cd8b0af4ddf4d1fc80cc7a9637","title":"Auto-populate API Keys","slug":"learn/docs/api-references/api-explorer/auto-populate-api-keys","icon":"fa-regular fa-key","pageId":"pages/docs/api-references/autopopulate-api-key.mdx"},{"type":"page","id":"419578bc1c9ab2e10023fab2fa3f7029f4f3439a0e02479f0f9f0a653bae1361","title":"Advanced Configuration","slug":"learn/docs/api-references/api-explorer/advanced-configuration","icon":"fa-regular fa-screwdriver-wrench","pageId":"pages/docs/api-references/customize-api-explorer.mdx"}],"title":"API Explorer","slug":"learn/docs/api-references/api-explorer","icon":"fa-regular fa-play","overviewPageId":"pages/docs/api-references/api-explorer.mdx"},{"type":"page","id":"623ed396a9bdad7f90dfe7ffd30ba6f9b8016085eac798c059f13d3aa3c6ff67","title":"Endpoint Errors","slug":"learn/docs/api-references/endpoint-errors","icon":"fa-regular fa-triangle-exclamation","pageId":"pages/docs/api-references/endpoint-errors.mdx"},{"type":"page","id":"2ff14a0b8652580da9a00c5b1492f5b46c284e479e72c133a1904b0758cd0e90","title":"Audiences","slug":"learn/docs/api-references/audiences","icon":"fa-regular fa-user-group","pageId":"pages/docs/api-references/audiences.mdx"},{"type":"page","id":"569cc6b0f13a966a357a837f1c4a4227f85f204026f30f589c050662cb7ee25b","title":"Customize API Reference Layout","slug":"learn/docs/api-references/customize-api-reference-layout","icon":"fa-regular fa-arrows-up-down-left-right","pageId":"pages/docs/api-references/customize-api-ref.mdx"},{"type":"page","id":"a139dff5f49968181e15c5e7c154b95e49bb25ee0ab4d1ef37dbe62262bc4b6d","title":"Write Markdown in API Reference","slug":"learn/docs/api-references/write-markdown-in-api-reference","icon":"fa-regular fa-pencil","pageId":"pages/docs/api-references/api-ref-content.mdx"},{"type":"page","id":"473fc5411d4512e3d542c523a68186b15b5d916320d1a1019dffedf5bff47e6b","title":"Generate Webhook Reference","slug":"learn/docs/api-references/generate-webhook-reference","icon":"fa-regular fa-webhook","pageId":"pages/docs/api-references/generate-webhook-ref.mdx"}],"title":"API References","slug":"learn/docs/api-references","pointsTo":"learn/docs/api-references/generate-api-ref"},{"type":"section","id":"ce0420e737b9cb1b4b452c2d323548a8b4eea071c31c69f0f570f711d1bf92a9","children":[{"type":"page","id":"bdb37eaea71d426aed5e9bfbfc9cca4f9aa7798d610e9a8f6dac03742bb115ac","title":"Overview","slug":"learn/docs/integrations/overview","icon":"fa-regular fa-plug","pageId":"pages/docs/integrations/overview.mdx"},{"type":"section","id":"8f8712c9bd511a977de54cc4d0e77d9f6c50abec8e2300fa6f50ee0050cd610f","children":[{"type":"page","id":"20d07a09d06ec285a1392b3d04d0ab1c96bde43ccc2844dd1d80c6311e0dccfc","title":"Google Analytics","slug":"learn/docs/integrations/analytics/google","pageId":"pages/docs/integrations/analytics/google.mdx"},{"type":"page","id":"4d553d06ecebc0d1b5a80784dcd9ee6086ad68a61e7db3ff3a89cc6929172509","title":"PostHog","slug":"learn/docs/integrations/analytics/posthog","pageId":"pages/docs/integrations/analytics/posthog.mdx"},{"type":"page","id":"8fadc6169cd323b7cc9882ff85a05269428f11dda8c0d88ef3f3cdaf26bfeacf","title":"Fullstory","slug":"learn/docs/integrations/analytics/fullstory","pageId":"pages/docs/integrations/analytics/fullstory.mdx"},{"type":"page","id":"e865e7c1a649fe38c8f120bde4a3b22d698e8249e5b5e6497d22bf263e4b2f2c","title":"Segment","slug":"learn/docs/integrations/analytics/segment","pageId":"pages/docs/integrations/analytics/segment.mdx"}],"title":"Analytics","slug":"learn/docs/integrations/analytics","icon":"fa-regular fa-chart-line","pointsTo":"learn/docs/integrations/analytics/google"},{"type":"section","id":"6c69ad54c26d23d986e57731518d8c5c86bced343989ffa1644226df485abbf9","children":[{"type":"page","id":"15766c1b388357bee4eebee7b531b42ccc597b5539d718b7718047d54e57730b","title":"Intercom","slug":"learn/docs/integrations/support/intercom","icon":"fa-brands fa-intercom","pageId":"pages/docs/integrations/support/intercom.mdx"}],"title":"Support","slug":"learn/docs/integrations/support","icon":"fa-regular fa-headset","pointsTo":"learn/docs/integrations/support/intercom"},{"type":"page","id":"ae8e54dcf80db43a02bfc441137a5234a72fbacb1d117dab0feed71df2205fed","title":"Postman","slug":"learn/docs/integrations/postman","icon":"fa-solid fa-user-astronaut","pageId":"pages/docs/integrations/postman.mdx"}],"title":"Integrations","slug":"learn/docs/integrations","pointsTo":"learn/docs/integrations/overview"},{"type":"section","id":"a01ea64129cf2a14238135fad2e42e3b849ca6b7d1f5999f2f994d4909d2d0b2","children":[{"type":"page","id":"978bdd2cdd672cf0fb2e1e5d7faefdfd530ad468ac9b37a39369dbc055f44954","title":"LLMs.txt","slug":"learn/docs/developer-tools/llms-txt","icon":"fa-regular fa-laptop-code","pageId":"pages/docs/developer-tools/llms-txt.mdx"},{"type":"page","id":"d93cfdecb41d402b8a4cd4ad36fcac7b83c1dd2c64f970af3ba67be637a2e979","title":"Cursor","slug":"learn/docs/developer-tools/cursor","icon":"fa-regular fa-mouse-pointer","pageId":"pages/docs/developer-tools/cursor.mdx"},{"type":"page","id":"f4320c9bc4675b24ceb3836b452025ed05bd0f65b2d6c1615c4dd4da122f088e","title":"GitLab","slug":"learn/docs/developer-tools/gitlab","icon":"fa-brands fa-gitlab","pageId":"pages/docs/developer-tools/gitlab.mdx"},{"type":"page","id":"485849d021f1d527d4befa951248c93f08440df876e23a4c54e89680310d4800","title":"Vale","slug":"learn/docs/developer-tools/vale","icon":"fa-regular fa-shield-check","pageId":"pages/docs/developer-tools/vale.mdx"}],"title":"Developer Tools","slug":"learn/docs/developer-tools","pointsTo":"learn/docs/developer-tools/llms-txt"},{"type":"section","id":"2ac59b42ac1706b2269cf9ee99da7bc2c5b2de19f5a26a5af9621c161d8f9179","children":[{"type":"page","id":"9b3ab1f6bd9db6091316498a060a605d1f623239a54765ac631782f548760a16","title":"ReadMe","slug":"learn/docs/alternatives/readme","pageId":"pages/docs/comparison/readme.mdx"},{"type":"page","id":"47d576ae2fab954650f2f55564a3a6a134a96e58228b09ea41ea6827c8263e8a","title":"Mintlify","slug":"learn/docs/alternatives/mintlify","pageId":"pages/docs/comparison/mintlify.mdx"}],"title":"Alternatives","slug":"learn/docs/alternatives","hidden":true,"pointsTo":"learn/docs/alternatives/readme"}]},"trailingSlash":false},"edgeFlags":{"isApiPlaygroundEnabled":false,"isApiScrollingDisabled":false,"isWhitelabeled":false,"isSeoDisabled":false,"isTocDefaultEnabled":false,"isSnippetTemplatesEnabled":false,"isSearchDisabled":false,"isHttpSnippetsEnabled":false,"isInlineFeedbackEnabled":false,"isDarkCodeEnabled":false,"isProxyDisabled":false,"isImageZoomDisabled":false,"useJavaScriptAsTypeScript":false,"alwaysEnableJavaScriptFetch":false,"scrollInContainerEnabled":false,"useMdxBundler":false,"isBatchStreamToggleDisabled":false,"isAuthEnabledInDocs":false,"isAskAiEnabled":true,"isAudioFileDownloadSpanSummary":false,"isDocsLogoTextEnabled":false,"isAudioExampleInternal":false,"usesApplicationJsonInFormDataValue":false,"isBinaryOctetStreamAudioPlayer":false,"hasVoiceIdPlaygroundForm":false,"isCohereTheme":false,"isFileForgeHackEnabled":false,"is404PageHidden":false,"isNewSearchExperienceEnabled":false,"isAuthenticatedPagesDiscoverable":false,"isSearchV2Enabled":true},"apis":["ee3e6a45-53b7-4dcd-83e4-27a9d6d6aae5"],"seo":{"openGraph":{"siteName":"Fern"},"twitter":{},"additionalMetaTags":[],"additionalLinkTags":[{"rel":"icon","href":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/images/favicon.ico","crossOrigin":"anonymous"},{"rel":"preload","href":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"},{"rel":"preload","href":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Medium.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"},{"rel":"preload","href":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"},{"rel":"preload","href":"https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2","as":"font","type":"font/woff2","crossOrigin":"anonymous"}],"breadcrumbList":{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Fern","item":"https://buildwithfern.com/learn"},{"@type":"ListItem","position":2,"name":"Docs","item":"https://buildwithfern.com/learn/docs"},{"@type":"ListItem","position":3,"name":"Getting Started","item":"https://buildwithfern.com/learn/docs/getting-started"},{"@type":"ListItem","position":4,"name":"Quickstart","item":"https://buildwithfern.com/learn/docs/getting-started/quickstart"}]},"canonical":"https://buildwithfern.com/learn/docs/getting-started/quickstart","title":"Quickstart","description":"Start building beautiful documentation in under 5 minutes","titleTemplate":"%s — Fern","noindex":false,"nofollow":false},"fallback":{},"theme":"default","analyticsConfig":{"posthog":{"apiKey":"phc_yQgAEdJJkVpI24NdSRID2mor1x1leRpDoC9yZ9mfXal"},"gtm":{"containerId":"GTM-55W3VNDW"}},"defaultLang":"curl","stylesheet":"\n:root {\n --typography-body-font-family: 'GT-Planar', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;\n --typography-heading-font-family: 'GT-Planar-Bold', -apple-system,BlinkMacSystemFont,Segoe UI,Roboto,Oxygen,Ubuntu,Cantarell,Open Sans,Helvetica Neue,sans-serif;\n --typography-code-font-family: ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,Liberation Mono,Courier New,monospace;\n --spacing-page-width: 1504px;\n --spacing-content-width: 44rem;\n --spacing-content-wide-width: 66.5rem;\n --spacing-sidebar-width: 18rem;\n --spacing-header-height: 7.4375rem;\n --spacing-header-height-padded: 91px;\n --spacing-header-height-real: 4.6875rem;\n \n --grayscale-1: var(--sand-1);\n --grayscale-2: var(--sand-2);\n --grayscale-3: var(--sand-3);\n --grayscale-4: var(--sand-4);\n --grayscale-5: var(--sand-5);\n --grayscale-6: var(--sand-6);\n --grayscale-7: var(--sand-7);\n --grayscale-8: var(--sand-8);\n --grayscale-9: var(--sand-9);\n --grayscale-10: var(--sand-10);\n --grayscale-11: var(--sand-11);\n --grayscale-12: var(--sand-12);\n --grayscale-a1: var(--sand-a1);\n --grayscale-a2: var(--sand-a2);\n --grayscale-a3: var(--sand-a3);\n --grayscale-a4: var(--sand-a4);\n --grayscale-a5: var(--sand-a5);\n --grayscale-a6: var(--sand-a6);\n --grayscale-a7: var(--sand-a7);\n --grayscale-a8: var(--sand-a8);\n --grayscale-a9: var(--sand-a9);\n --grayscale-a10: var(--sand-a10);\n --grayscale-a11: var(--sand-a11);\n --grayscale-a12: var(--sand-a12);\n --accent-1: #f8fdf8;\n --accent-2: #f0fbf0;\n --accent-3: #d1fed0;\n --accent-4: #b4fcb4;\n --accent-5: #98f699;\n --accent-6: #86e888;\n --accent-7: #73d476;\n --accent-8: #5bbc5f;\n --accent-9: #0d4c14;\n --accent-10: #235e26;\n --accent-11: #188326;\n --accent-12: #06480f;\n --accent-a1: #3c807b04;\n --accent-a2: #12aa260c;\n --accent-a3: #02fa012b;\n --accent-a4: #03f50649;\n --accent-a5: #01e90665;\n --accent-a6: #01ce0677;\n --accent-a7: #02b1088b;\n --accent-a8: #009608a3;\n --accent-a9: #004207f2;\n --accent-a10: #014405dc;\n --accent-a11: #007610e7;\n --accent-a12: #004409f9;\n --accent-surface: #eefaeecc;\n --gray-surface: #ffffffcc;\n --accent: 13, 76, 20;\n --accent-aa: 13, 76, 20;\n --accent-aaa: 13, 76, 20;\n --accent-tinted: 9, 54, 14;\n --background: 251, 255, 250;\n --accent-contrast: rgb(255, 255, 255);\n --bg-color-card: rgba(255, 255, 255, 0.7);\n --sidebar-background: transparent;\n --header-background: rgb(251, 255, 250);\n --border: var(--grayscale-a4);\n --border-concealed: var(--grayscale-a2);\n --body-text: 0, 0, 0;\n --body-text-inverted: 255, 255, 255;\n}\n\n@media (max-width: 1024px) {\n :root {\n --spacing-header-height: 7.4375rem;\n --spacing-header-height-padded: 91px;\n }\n}\n\n\n:is(.dark) {\n --grayscale-1: var(--olive-1);\n --grayscale-2: var(--olive-2);\n --grayscale-3: var(--olive-3);\n --grayscale-4: var(--olive-4);\n --grayscale-5: var(--olive-5);\n --grayscale-6: var(--olive-6);\n --grayscale-7: var(--olive-7);\n --grayscale-8: var(--olive-8);\n --grayscale-9: var(--olive-9);\n --grayscale-10: var(--olive-10);\n --grayscale-11: var(--olive-11);\n --grayscale-12: var(--olive-12);\n --grayscale-a1: var(--olive-a1);\n --grayscale-a2: var(--olive-a2);\n --grayscale-a3: var(--olive-a3);\n --grayscale-a4: var(--olive-a4);\n --grayscale-a5: var(--olive-a5);\n --grayscale-a6: var(--olive-a6);\n --grayscale-a7: var(--olive-a7);\n --grayscale-a8: var(--olive-a8);\n --grayscale-a9: var(--olive-a9);\n --grayscale-a10: var(--olive-a10);\n --grayscale-a11: var(--olive-a11);\n --grayscale-a12: var(--olive-a12);\n --accent-1: #091009;\n --accent-2: #111b11;\n --accent-3: #132d13;\n --accent-4: #123c13;\n --accent-5: #184a19;\n --accent-6: #205921;\n --accent-7: #276a29;\n --accent-8: #2d7f30;\n --accent-9: #2bdb3c;\n --accent-10: #0ed02d;\n --accent-11: #2cdc3d;\n --accent-12: #aff5ad;\n --accent-a1: #88108802;\n --accent-a2: #c8fac80c;\n --accent-a3: #63ff631f;\n --accent-a4: #3eff432f;\n --accent-a5: #4aff4e3e;\n --accent-a6: #56ff594e;\n --accent-a7: #5afd5f61;\n --accent-a8: #58fd5e77;\n --accent-a9: #31ff45d9;\n --accent-a10: #0fff36cd;\n --accent-a11: #32ff46da;\n --accent-a12: #b6feb4f5;\n --accent-surface: color(display-p3 0.1098 0.1412 0.102 / 0.5);\n --gray-surface: color(display-p3 0 0 0 / 5%);\n --accent: 43, 219, 60;\n --accent-aa: 43, 219, 60;\n --accent-aaa: 43, 219, 60;\n --accent-tinted: 65, 223, 80;\n --background: 8, 16, 8;\n --accent-contrast: rgb(21, 39, 21);\n --bg-color-card: rgba(5, 9, 5, 0.5);\n --bg-color-card-solid: rgb(6, 13, 6);\n --sidebar-background: transparent;\n --header-background: rgb(8, 16, 8);\n --border: var(--grayscale-a4);\n --border-concealed: var(--grayscale-a2);\n --body-text: 255, 255, 255;\n --body-text-inverted: 0, 0, 0;\n}\n\n@font-face {\n font-family: 'GT-Planar';\n src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar.woff2') format('woff2');\n font-weight: 400;\n font-style: normal;\n font-display: swap;\n}\n\n@font-face {\n font-family: 'GT-Planar';\n src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Medium.woff2') format('woff2');\n font-weight: 500;\n font-style: normal;\n font-display: swap;\n}\n\n@font-face {\n font-family: 'GT-Planar';\n src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2') format('woff2');\n font-weight: 600 700;\n font-style: normal;\n font-display: swap;\n}\n\n@font-face {\n font-family: 'GT-Planar-Bold';\n src: url('https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-02-18T01:21:18.347Z/assets/GT-Planar-Bold.woff2') format('woff2');\n font-weight: 600 700;\n font-style: normal;\n font-display: swap;\n}\n\nhtml {\n background-color: #fbfffa;\n}\n\nhtml.dark {\n background-color: #081008;\n}\n\n\n\n.motivation p {\n max-width: unset !important;\n}\n\n.showcase h2 {\n margin-bottom: 0.25em;\n}\n\n:is(.dark) .showcase .logo-icon {\n filter: invert(1);\n margin-top: 0px;\n margin-bottom: 0px;\n}\n\n.logo-icon {\n margin-right: 10px;\n}\n\n","featureFlagsConfig":{}},"__N_SSG":true},"page":"/static/[domain]/[[...slug]]","query":{"domain":"buildwithfern.com","slug":["learn","docs","getting-started","quickstart"]},"buildId":"QJggA6sLAGu-ommXPhsGG","assetPrefix":"https://app.ferndocs.com","isFallback":false,"isExperimentalCompile":false,"dynamicIds":[58494,47191,39862,27532,98508,37110,46993],"gsp":true,"scriptLoader":[]}</script></body></html>

Pages: 1 2 3 4 5 6 7 8 9 10