Skip to content

Add Schema component to docs.yml reference page #1750

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Schema component to docs.yml reference page #1750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,8 @@ instances:
- public
```

<Schema type="DocsInstance" />

<ParamField path="instances" type="list of objects" required={false} toc={true}>
Configure one or more documentation websites.
</ParamField>
Expand Down Expand Up @@ -174,6 +176,8 @@ colors:
dark: "#1f2937"
```

<Schema type="ColorsConfiguration" />

<ParamField path="accent-primary" type="object" required={true} toc={true}>
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.
Expand Down Expand Up @@ -213,6 +217,8 @@ logo:
light: assets/images/logo-light.svg
```

<Schema type="LogoConfiguration" />

<ParamField path="logo.href" type="string" required={false} toc={true}>
The URL that users will be directed to when clicking the logo. Typically your company's homepage or app.
</ParamField>
Expand All @@ -227,6 +233,8 @@ logo:

## Redirects configuration

<Schema type="RedirectConfig" />

<Markdown src="/snippets/redirects.mdx" />

## NavBar links configuration
Expand Down Expand Up @@ -259,6 +267,8 @@ navbar-links:
icon: fa-regular fa-graduation-cap
```

<Schema type="NavbarLink" />

<ParamField path="type" type="enum" required={false} toc={true}>
One of `outlined`, `minimal`, `filled`, `github`, or `dropdown`. This value controls the styling of the button.
</ParamField>
Expand Down Expand Up @@ -341,6 +351,8 @@ footer-links:
website: https://yourwebsite.com
```

<Schema type="FooterLinksConfig" />

<ParamField path="footer-links.github" type="string" required={false} toc={true}>
URL to your GitHub repository or organization.
</ParamField>
Expand Down Expand Up @@ -397,6 +409,8 @@ background-image:
dark: ./path/to/bg-dark.svg
```

<Schema type="BackgroundImageConfiguration" />

<ParamField path="background-image.light" type="string" required={false} toc={true}>
Relative filepath to the light-mode background image.
</ParamField>
Expand Down Expand Up @@ -430,6 +444,8 @@ typography:
path: ./fonts/JetBrains-Mono-Regular.woff2
```

<Schema type="DocsTypographyConfig" />

<ParamField path="typography.bodyFont" type="object" required={false} toc={true}>
The font used for all body text including paragraphs, lists, and general content.
For optimal performance, use WOFF2 format.
Expand Down Expand Up @@ -489,6 +505,8 @@ typography:
</Tab>
</Tabs>

<Schema type="FontConfig" />

<ParamField path="name" type="string" required={false} toc={true}>
The name of the font. Defaults to a generated name that will be used to reference your custom font in the eventually injected CSS.
</ParamField>
Expand Down Expand Up @@ -525,6 +543,8 @@ layout:
hide-feedback: true
```

<Schema type="LayoutConfig" />

<ParamField path="layout.header-height" type="string" required={false} toc={true}>
Sets the height of the header. Defaults to `4rem` (`64px`). Valid options are `{number}rem` or `{number}px`.
</ParamField>
Expand Down Expand Up @@ -719,6 +739,8 @@ instances:
</Tab>
</Tabs>

<Schema type="GithubEditThisPageConfig" />

<Warning>
The GitHub repository must be **public** for the "Edit this page" feature to work correctly.
</Warning>
Expand All @@ -744,6 +766,8 @@ landing-page:
slug: /welcome
```

<Schema type="PageConfiguration" />

<ParamField path="page" type="string" required={true} toc={true}>
The name of the landing page.
</ParamField>
Expand All @@ -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).
</Note>

<Schema type="MetadataConfig" />

<Markdown src="/snippets/seo-metadata-site.mdx" />

## Analytics configuration
Expand All @@ -780,6 +806,8 @@ analytics:
api-key: "phc_xxxxxxxxxxxx"
```

<Schema type="AnalyticsConfig" />

<ParamField path="analytics.ga4.measurement-id" type="string" required={false} toc={true}>
Your Google Analytics 4 measurement ID. Must start with "G-".
</ParamField>
Expand Down Expand Up @@ -813,4 +841,6 @@ experimental:
dynamic-snippets: true
```

<Schema type="ExperimentalConfig" />