diff --git a/fern/products/docs/pages/customization/what-is-docs-yml.mdx b/fern/products/docs/pages/customization/what-is-docs-yml.mdx index 66b6b776c..d1f89d968 100644 --- a/fern/products/docs/pages/customization/what-is-docs-yml.mdx +++ b/fern/products/docs/pages/customization/what-is-docs-yml.mdx @@ -123,6 +123,8 @@ instances: - public ``` + + Configure one or more documentation websites. @@ -174,6 +176,8 @@ colors: dark: "#1f2937" ``` + + The primary brand color used for interactive elements like links, buttons, and highlighted text. Configure separate colors for light and dark modes to ensure proper contrast and visibility. @@ -213,6 +217,8 @@ logo: light: assets/images/logo-light.svg ``` + + The URL that users will be directed to when clicking the logo. Typically your company's homepage or app. @@ -227,6 +233,8 @@ logo: ## Redirects configuration + + ## NavBar links configuration @@ -259,6 +267,8 @@ navbar-links: icon: fa-regular fa-graduation-cap ``` + + One of `outlined`, `minimal`, `filled`, `github`, or `dropdown`. This value controls the styling of the button. @@ -341,6 +351,8 @@ footer-links: website: https://yourwebsite.com ``` + + URL to your GitHub repository or organization. @@ -397,6 +409,8 @@ background-image: dark: ./path/to/bg-dark.svg ``` + + Relative filepath to the light-mode background image. @@ -430,6 +444,8 @@ typography: path: ./fonts/JetBrains-Mono-Regular.woff2 ``` + + The font used for all body text including paragraphs, lists, and general content. For optimal performance, use WOFF2 format. @@ -489,6 +505,8 @@ typography: + + The name of the font. Defaults to a generated name that will be used to reference your custom font in the eventually injected CSS. @@ -525,6 +543,8 @@ layout: hide-feedback: true ``` + + Sets the height of the header. Defaults to `4rem` (`64px`). Valid options are `{number}rem` or `{number}px`. @@ -719,6 +739,8 @@ instances: + + The GitHub repository must be **public** for the "Edit this page" feature to work correctly. @@ -744,6 +766,8 @@ landing-page: slug: /welcome ``` + + The name of the landing page. @@ -766,6 +790,8 @@ See [Vapi's landing page live](https://docs.vapi.ai/) and the associated [Markdo [Use the `keywords` property in a page's frontmatter](/docs/configuration/page-level-settings#seo-metadata). + + ## Analytics configuration @@ -780,6 +806,8 @@ analytics: api-key: "phc_xxxxxxxxxxxx" ``` + + Your Google Analytics 4 measurement ID. Must start with "G-". @@ -813,4 +841,6 @@ experimental: dynamic-snippets: true ``` + +