@@ -123,6 +123,8 @@ instances:
123123 - public
124124` ` `
125125
126+ <Schema type="DocsInstance" />
127+
126128<ParamField path="instances" type="list of objects" required={false} toc={true}>
127129 Configure one or more documentation websites.
128130</ParamField>
@@ -174,6 +176,8 @@ colors:
174176 dark: "#1f2937"
175177` ` `
176178
179+ <Schema type="ColorsConfiguration" />
180+
177181<ParamField path="accent-primary" type="object" required={true} toc={true}>
178182 The primary brand color used for interactive elements like links, buttons, and highlighted text.
179183 Configure separate colors for light and dark modes to ensure proper contrast and visibility.
@@ -213,6 +217,8 @@ logo:
213217 light: assets/images/logo-light.svg
214218` ` `
215219
220+ <Schema type="LogoConfiguration" />
221+
216222<ParamField path="logo.href" type="string" required={false} toc={true}>
217223 The URL that users will be directed to when clicking the logo. Typically your company's homepage or app.
218224</ParamField>
@@ -227,6 +233,8 @@ logo:
227233
228234# # Redirects configuration
229235
236+ <Schema type="RedirectConfig" />
237+
230238<Markdown src="/snippets/redirects.mdx" />
231239
232240# # NavBar links configuration
@@ -259,6 +267,8 @@ navbar-links:
259267 icon: fa-regular fa-graduation-cap
260268` ` `
261269
270+ <Schema type="NavbarLink" />
271+
262272<ParamField path="type" type="enum" required={false} toc={true}>
263273 One of `outlined`, `minimal`, `filled`, `github`, or `dropdown`. This value controls the styling of the button.
264274</ParamField>
@@ -341,6 +351,8 @@ footer-links:
341351 website: https://yourwebsite.com
342352` ` `
343353
354+ <Schema type="FooterLinksConfig" />
355+
344356<ParamField path="footer-links.github" type="string" required={false} toc={true}>
345357 URL to your GitHub repository or organization.
346358</ParamField>
@@ -397,6 +409,8 @@ background-image:
397409 dark: ./path/to/bg-dark.svg
398410` ` `
399411
412+ <Schema type="BackgroundImageConfiguration" />
413+
400414<ParamField path="background-image.light" type="string" required={false} toc={true}>
401415 Relative filepath to the light-mode background image.
402416</ParamField>
@@ -430,6 +444,8 @@ typography:
430444 path: ./fonts/JetBrains-Mono-Regular.woff2
431445` ` `
432446
447+ <Schema type="DocsTypographyConfig" />
448+
433449<ParamField path="typography.bodyFont" type="object" required={false} toc={true}>
434450 The font used for all body text including paragraphs, lists, and general content.
435451 For optimal performance, use WOFF2 format.
@@ -489,6 +505,8 @@ typography:
489505</Tab>
490506</Tabs>
491507
508+ <Schema type="FontConfig" />
509+
492510<ParamField path="name" type="string" required={false} toc={true}>
493511 The name of the font. Defaults to a generated name that will be used to reference your custom font in the eventually injected CSS.
494512</ParamField>
@@ -525,6 +543,8 @@ layout:
525543 hide-feedback: true
526544` ` `
527545
546+ <Schema type="LayoutConfig" />
547+
528548<ParamField path="layout.header-height" type="string" required={false} toc={true}>
529549 Sets the height of the header. Defaults to `4rem` (`64px`). Valid options are `{number}rem` or `{number}px`.
530550</ParamField>
@@ -719,6 +739,8 @@ instances:
719739</Tab>
720740</Tabs>
721741
742+ <Schema type="GithubEditThisPageConfig" />
743+
722744<Warning>
723745The GitHub repository must be **public** for the "Edit this page" feature to work correctly.
724746</Warning>
@@ -744,6 +766,8 @@ landing-page:
744766 slug: /welcome
745767` ` `
746768
769+ <Schema type="PageConfiguration" />
770+
747771<ParamField path="page" type="string" required={true} toc={true}>
748772 The name of the landing page.
749773</ParamField>
@@ -766,6 +790,8 @@ See [Vapi's landing page live](https://docs.vapi.ai/) and the associated [Markdo
766790 [Use the `keywords` property in a page's frontmatter](/docs/configuration/page-level-settings#seo-metadata).
767791</Note>
768792
793+ <Schema type="MetadataConfig" />
794+
769795<Markdown src="/snippets/seo-metadata-site.mdx" />
770796
771797# # Analytics configuration
@@ -780,6 +806,8 @@ analytics:
780806 api-key: "phc_xxxxxxxxxxxx"
781807` ` `
782808
809+ <Schema type="AnalyticsConfig" />
810+
783811<ParamField path="analytics.ga4.measurement-id" type="string" required={false} toc={true}>
784812 Your Google Analytics 4 measurement ID. Must start with "G-".
785813</ParamField>
@@ -813,4 +841,6 @@ experimental:
813841 dynamic-snippets: true
814842` ` `
815843
844+ <Schema type="ExperimentalConfig" />
845+
816846
0 commit comments