@mintlify/validation
Version:
Validates mint.json files
1,178 lines • 235 kB
TypeScript
import { z } from 'zod';
export declare function validateMintConfig(value: unknown): z.SafeParseError<{
name: string;
favicon: string;
colors: {
primary: string;
light?: string | undefined;
dark?: string | undefined;
background?: {
light?: string | undefined;
dark?: string | undefined;
} | undefined;
anchors?: string | {
from: string;
to: string;
via?: string | undefined;
} | undefined;
ultraLight?: any;
ultraDark?: any;
};
navigation: import("@mintlify/models").NavigationGroup[];
openapi?: string | string[] | undefined;
background?: {
style?: "gradient" | "grid" | "windows" | undefined;
} | undefined;
anchors?: {
name: string;
url: string;
icon?: string | undefined;
iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
color?: string | {
from: string;
to: string;
via?: string | undefined;
} | undefined;
isDefaultHidden?: boolean | undefined;
version?: string | undefined;
openapi?: string | undefined;
}[] | undefined;
$schema?: string | undefined;
mintlify?: string | undefined;
logo?: string | {
light: string;
dark: string;
href?: string | undefined;
} | undefined;
theme?: "venus" | "quill" | "prism" | undefined;
layout?: "topnav" | "sidenav" | "solidSidenav" | undefined;
topbar?: {
style?: "gradient" | "default" | undefined;
} | undefined;
sidebar?: {
items?: "container" | "card" | "border" | "undecorated" | undefined;
} | undefined;
rounded?: "default" | "sharp" | undefined;
api?: {
baseUrl?: string | string[] | undefined;
auth?: {
name?: string | undefined;
method?: "key" | "bearer" | "basic" | "cobo" | undefined;
inputPrefix?: string | undefined;
} | undefined;
playground?: {
mode?: "show" | "simple" | "hide" | undefined;
disableProxy?: boolean | undefined;
} | undefined;
request?: {
example?: {
showOptionalParams?: boolean | undefined;
languages?: string[] | undefined;
} | undefined;
} | undefined;
maintainOrder?: boolean | undefined;
paramFields?: {
expanded?: "all" | "topLevel" | "topLevelOneOfs" | "none" | undefined;
} | undefined;
} | undefined;
modeToggle?: {
default?: "light" | "dark" | undefined;
isHidden?: boolean | undefined;
} | undefined;
versions?: (string | {
name: string;
url?: string | undefined;
default?: true | undefined;
locale?: "id" | "en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "fr-CA" | "fr-ca" | "ja" | "jp" | "ja-jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "ro" | "cs" | "ar" | "tr" | "hi" | "sv" | "no" | "lv" | "nl" | "uk" | "vi" | undefined;
})[] | undefined;
metadata?: Record<string, string> | undefined;
codeBlock?: {
mode?: "dark" | "auto" | undefined;
} | undefined;
eyebrow?: {
display?: "section" | "breadcrumbs" | undefined;
} | undefined;
topbarCtaButton?: {
name: string;
url: string;
type?: "link" | undefined;
style?: "pill" | "roundedRectangle" | undefined;
arrow?: boolean | undefined;
} | {
type: "github";
url: string;
} | undefined;
topbarLinks?: ({
name: string;
url: string;
type?: "link" | undefined;
style?: "pill" | "roundedRectangle" | undefined;
arrow?: boolean | undefined;
} | {
type: "github";
url: string;
})[] | undefined;
primaryTab?: {
name: string;
isDefaultHidden?: boolean | undefined;
} | undefined;
topAnchor?: {
name: string;
icon?: string | undefined;
iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
} | undefined;
tabs?: {
name: string;
url: string;
isDefaultHidden?: boolean | undefined;
version?: string | undefined;
openapi?: string | undefined;
}[] | undefined;
footer?: {
links?: {
links: {
url: string;
label: string;
}[];
title?: string | undefined;
}[] | undefined;
socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast", string>> | {
type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast";
url: string;
}[] | undefined;
} | undefined;
backgroundImage?: string | undefined;
font?: {
family: string;
url?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | {
headings?: {
family: string;
url?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
body?: {
family: string;
url?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
} | undefined;
feedback?: {
thumbsRating?: boolean | undefined;
suggestEdit?: boolean | undefined;
raiseIssue?: boolean | undefined;
} | undefined;
analytics?: {
amplitude?: {
apiKey: string;
} | undefined;
clarity?: {
projectId: string;
} | undefined;
clearbit?: {
publicApiKey: string;
} | undefined;
fathom?: {
siteId: string;
} | undefined;
ga4?: {
measurementId: string;
} | undefined;
gtm?: {
tagId: string;
} | undefined;
heap?: {
appId: string;
} | undefined;
hightouch?: {
writeKey: string;
apiHost?: string | undefined;
} | undefined;
hotjar?: {
hjid: string;
hjsv: string;
} | undefined;
koala?: {
publicApiKey: string;
} | undefined;
logrocket?: {
appId: string;
} | undefined;
mixpanel?: {
projectToken: string;
} | undefined;
pirsch?: {
id: string;
} | undefined;
posthog?: {
apiKey: string;
apiHost?: string | undefined;
sessionRecording?: boolean | undefined;
} | undefined;
plausible?: {
domain: string;
server?: string | undefined;
} | undefined;
segment?: {
key: string;
} | undefined;
} | undefined;
integrations?: {
intercom?: string | undefined;
frontchat?: string | undefined;
osano?: string | undefined;
} | undefined;
isWhiteLabeled?: boolean | undefined;
search?: {
prompt?: string | undefined;
location?: "side" | "top" | undefined;
} | undefined;
redirects?: {
source: string;
destination: string;
permanent?: boolean | undefined;
}[] | undefined;
seo?: {
indexHiddenPages?: boolean | undefined;
} | undefined;
footerSocials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast", string>> | {
type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast";
url: string;
}[] | undefined;
}> | {
warnings: z.ZodIssue[];
success: true;
data: {
name: string;
$schema: string;
favicon: string;
colors: {
primary: string;
light?: string | undefined;
dark?: string | undefined;
background?: {
light?: string | undefined;
dark?: string | undefined;
} | undefined;
anchors?: string | {
from: string;
to: string;
via?: string | undefined;
} | undefined;
ultraLight?: any;
ultraDark?: any;
};
navigation: import("@mintlify/models").NavigationGroup[];
openapi?: string | string[] | undefined;
background?: {
style?: "gradient" | "grid" | "windows" | undefined;
} | undefined;
anchors?: {
name: string;
url: string;
icon?: string | undefined;
iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
color?: string | {
from: string;
to: string;
via?: string | undefined;
} | undefined;
isDefaultHidden?: boolean | undefined;
version?: string | undefined;
openapi?: string | undefined;
}[] | undefined;
mintlify?: string | undefined;
logo?: string | {
light: string;
dark: string;
href?: string | undefined;
} | undefined;
theme?: "venus" | "quill" | "prism" | undefined;
layout?: "topnav" | "sidenav" | "solidSidenav" | undefined;
topbar?: {
style?: "gradient" | "default" | undefined;
} | undefined;
sidebar?: {
items?: "container" | "card" | "border" | "undecorated" | undefined;
} | undefined;
rounded?: "default" | "sharp" | undefined;
api?: {
baseUrl?: string | string[] | undefined;
auth?: {
name?: string | undefined;
method?: "key" | "bearer" | "basic" | "cobo" | undefined;
inputPrefix?: string | undefined;
} | undefined;
playground?: {
mode: "show" | "simple" | "hide";
disableProxy?: boolean | undefined;
} | undefined;
request?: {
example?: {
showOptionalParams?: boolean | undefined;
languages?: string[] | undefined;
} | undefined;
} | undefined;
maintainOrder?: boolean | undefined;
paramFields?: {
expanded?: "all" | "topLevel" | "topLevelOneOfs" | "none" | undefined;
} | undefined;
} | undefined;
modeToggle?: {
default?: "light" | "dark" | undefined;
isHidden?: boolean | undefined;
} | undefined;
versions?: (string | {
name: string;
url?: string | undefined;
default?: true | undefined;
locale?: "id" | "en" | "cn" | "zh" | "zh-Hans" | "zh-Hant" | "es" | "fr" | "fr-CA" | "fr-ca" | "ja" | "jp" | "ja-jp" | "pt" | "pt-BR" | "de" | "ko" | "it" | "ru" | "ro" | "cs" | "ar" | "tr" | "hi" | "sv" | "no" | "lv" | "nl" | "uk" | "vi" | undefined;
})[] | undefined;
metadata?: Record<string, string> | undefined;
codeBlock?: {
mode?: "dark" | "auto" | undefined;
} | undefined;
eyebrow?: {
display?: "section" | "breadcrumbs" | undefined;
} | undefined;
topbarCtaButton?: {
name: string;
url: string;
type?: "link" | undefined;
style?: "pill" | "roundedRectangle" | undefined;
arrow?: boolean | undefined;
} | {
type: "github";
url: string;
} | undefined;
topbarLinks?: ({
name: string;
url: string;
type?: "link" | undefined;
style?: "pill" | "roundedRectangle" | undefined;
arrow?: boolean | undefined;
} | {
type: "github";
url: string;
})[] | undefined;
primaryTab?: {
name: string;
isDefaultHidden?: boolean | undefined;
} | undefined;
topAnchor?: {
name: string;
icon?: string | undefined;
iconType?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
} | undefined;
tabs?: {
name: string;
url: string;
isDefaultHidden?: boolean | undefined;
version?: string | undefined;
openapi?: string | undefined;
}[] | undefined;
footer?: {
links?: {
links: {
url: string;
label: string;
}[];
title?: string | undefined;
}[] | undefined;
socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast", string>> | {
type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast";
url: string;
}[] | undefined;
} | undefined;
backgroundImage?: string | undefined;
font?: {
family: string;
url?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | {
headings?: {
family: string;
url?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
body?: {
family: string;
url?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
} | undefined;
feedback?: {
thumbsRating?: boolean | undefined;
suggestEdit?: boolean | undefined;
raiseIssue?: boolean | undefined;
} | undefined;
analytics?: {
amplitude?: {
apiKey: string;
} | undefined;
clarity?: {
projectId: string;
} | undefined;
clearbit?: {
publicApiKey: string;
} | undefined;
fathom?: {
siteId: string;
} | undefined;
ga4?: {
measurementId: string;
} | undefined;
gtm?: {
tagId: string;
} | undefined;
heap?: {
appId: string;
} | undefined;
hightouch?: {
writeKey: string;
apiHost?: string | undefined;
} | undefined;
hotjar?: {
hjid: string;
hjsv: string;
} | undefined;
koala?: {
publicApiKey: string;
} | undefined;
logrocket?: {
appId: string;
} | undefined;
mixpanel?: {
projectToken: string;
} | undefined;
pirsch?: {
id: string;
} | undefined;
posthog?: {
apiKey: string;
apiHost?: string | undefined;
sessionRecording?: boolean | undefined;
} | undefined;
plausible?: {
domain: string;
server?: string | undefined;
} | undefined;
segment?: {
key: string;
} | undefined;
} | undefined;
integrations?: {
intercom?: string | undefined;
frontchat?: string | undefined;
osano?: string | undefined;
} | undefined;
isWhiteLabeled?: boolean | undefined;
search?: {
prompt?: string | undefined;
location?: "side" | "top" | undefined;
} | undefined;
redirects?: {
source: string;
destination: string;
permanent?: boolean | undefined;
}[] | undefined;
seo?: {
indexHiddenPages?: boolean | undefined;
} | undefined;
footerSocials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast", string>> | {
type: "github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast";
url: string;
}[] | undefined;
};
error?: never;
};
export declare function validateDocsConfig(value: unknown): z.SafeParseError<{
name: string;
theme: "almond";
colors: {
primary: string;
light?: string | undefined;
dark?: string | undefined;
};
navigation: {
products: import("./schemas/v2/properties/navigation/divisionNav.js").ProductNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
languages: import("./schemas/v2/properties/navigation/divisionNav.js").LanguageNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
versions: import("./schemas/v2/properties/navigation/divisionNav.js").VersionNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
tabs: import("./schemas/v2/properties/navigation/divisionNav.js").TabNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
dropdowns: import("./schemas/v2/properties/navigation/divisionNav.js").DropdownNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
anchors: import("./schemas/v2/properties/navigation/divisionNav.js").AnchorNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
groups: ({
openapi: string | string[] | {
source: string;
directory?: string | undefined;
};
group: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
expanded?: boolean | undefined;
public?: boolean | undefined;
pages?: any[] | undefined;
tag?: string | undefined;
hidden?: boolean | undefined;
root?: string | undefined;
} | {
group: string;
asyncapi: string | string[] | {
source: string;
directory?: string | undefined;
};
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
expanded?: boolean | undefined;
public?: boolean | undefined;
pages?: any[] | undefined;
tag?: string | undefined;
hidden?: boolean | undefined;
root?: string | undefined;
} | {
group: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
expanded?: boolean | undefined;
public?: boolean | undefined;
pages?: any[] | undefined;
tag?: string | undefined;
hidden?: boolean | undefined;
root?: string | undefined;
})[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
pages: any[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
};
background?: {
color?: {
light?: string | undefined;
dark?: string | undefined;
} | undefined;
image?: string | {
light: string;
dark: string;
} | undefined;
decoration?: "gradient" | "grid" | "windows" | undefined;
} | undefined;
$schema?: string | undefined;
logo?: string | {
light: string;
dark: string;
href?: string | undefined;
} | undefined;
favicon?: string | {
light: string;
dark: string;
} | undefined;
api?: {
params?: {
expanded?: "all" | "closed" | undefined;
} | undefined;
openapi?: string | string[] | {
source: string;
directory?: string | undefined;
} | undefined;
playground?: {
display?: "simple" | "none" | "interactive" | undefined;
proxy?: boolean | undefined;
} | undefined;
asyncapi?: string | string[] | {
source: string;
directory?: string | undefined;
} | undefined;
examples?: {
languages?: string[] | undefined;
defaults?: "all" | "required" | undefined;
prefill?: boolean | undefined;
} | undefined;
mdx?: {
server?: string | string[] | undefined;
auth?: {
name?: string | undefined;
method?: "key" | "bearer" | "basic" | "cobo" | undefined;
} | undefined;
} | undefined;
} | undefined;
metadata?: {
timestamp?: boolean | undefined;
} | undefined;
footer?: {
links?: {
items: {
href: string;
label: string;
}[];
header?: string | undefined;
}[] | undefined;
socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast", string>> | undefined;
} | undefined;
integrations?: {
amplitude?: {
apiKey: string;
} | undefined;
clarity?: {
projectId: string;
} | undefined;
clearbit?: {
publicApiKey: string;
} | undefined;
fathom?: {
siteId: string;
} | undefined;
ga4?: {
measurementId: string;
} | undefined;
gtm?: {
tagId: string;
} | undefined;
heap?: {
appId: string;
} | undefined;
hightouch?: {
writeKey: string;
apiHost?: string | undefined;
} | undefined;
hotjar?: {
hjid: string;
hjsv: string;
} | undefined;
koala?: {
publicApiKey: string;
} | undefined;
logrocket?: {
appId: string;
} | undefined;
mixpanel?: {
projectToken: string;
} | undefined;
pirsch?: {
id: string;
} | undefined;
posthog?: {
apiKey: string;
apiHost?: string | undefined;
} | undefined;
plausible?: {
domain: string;
server?: string | undefined;
} | undefined;
segment?: {
key: string;
} | undefined;
intercom?: {
appId: string;
} | undefined;
frontchat?: {
snippetId: string;
} | undefined;
osano?: {
scriptSource: string;
} | undefined;
telemetry?: {
enabled?: boolean | undefined;
} | undefined;
cookies?: {
value?: string | undefined;
key?: string | undefined;
} | undefined;
} | undefined;
search?: {
prompt?: string | undefined;
} | undefined;
redirects?: {
source: string;
destination: string;
permanent?: boolean | undefined;
}[] | undefined;
seo?: {
metatags?: Record<string, string> | undefined;
indexing?: "all" | "navigable" | undefined;
} | undefined;
description?: string | undefined;
appearance?: {
strict?: boolean | undefined;
default?: "light" | "dark" | "system" | undefined;
} | undefined;
fonts?: {
family: string;
source?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | {
body?: {
family: string;
source?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
heading?: {
family: string;
source?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
} | undefined;
navbar?: {
primary?: {
type: "button";
href: string;
label: string;
} | {
type: "github";
href: string;
} | undefined;
links?: {
href: string;
label: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
}[] | undefined;
} | undefined;
icons?: {
library: "fontawesome" | "lucide";
} | undefined;
styling?: {
eyebrows?: "section" | "breadcrumbs" | undefined;
codeblocks?: "dark" | "system" | {
languages?: {
custom?: string[] | undefined;
} | undefined;
theme?: "andromeeda" | "aurora-x" | "ayu-dark" | "catppuccin-frappe" | "catppuccin-latte" | "catppuccin-macchiato" | "catppuccin-mocha" | "dark-plus" | "dracula" | "dracula-soft" | "everforest-dark" | "everforest-light" | "github-dark" | "github-dark-default" | "github-dark-dimmed" | "github-dark-high-contrast" | "github-light" | "github-light-default" | "github-light-high-contrast" | "gruvbox-dark-hard" | "gruvbox-dark-medium" | "gruvbox-dark-soft" | "gruvbox-light-hard" | "gruvbox-light-medium" | "gruvbox-light-soft" | "houston" | "kanagawa-dragon" | "kanagawa-lotus" | "kanagawa-wave" | "laserwave" | "light-plus" | "material-theme" | "material-theme-darker" | "material-theme-lighter" | "material-theme-ocean" | "material-theme-palenight" | "min-dark" | "min-light" | "monokai" | "night-owl" | "nord" | "one-dark-pro" | "one-light" | "plastic" | "poimandres" | "red" | "rose-pine" | "rose-pine-dawn" | "rose-pine-moon" | "slack-dark" | "slack-ochin" | "snazzy-light" | "solarized-dark" | "solarized-light" | "synthwave-84" | "tokyo-night" | "vesper" | "vitesse-black" | "vitesse-dark" | "vitesse-light" | "css-variables" | {
light: "andromeeda" | "aurora-x" | "ayu-dark" | "catppuccin-frappe" | "catppuccin-latte" | "catppuccin-macchiato" | "catppuccin-mocha" | "dark-plus" | "dracula" | "dracula-soft" | "everforest-dark" | "everforest-light" | "github-dark" | "github-dark-default" | "github-dark-dimmed" | "github-dark-high-contrast" | "github-light" | "github-light-default" | "github-light-high-contrast" | "gruvbox-dark-hard" | "gruvbox-dark-medium" | "gruvbox-dark-soft" | "gruvbox-light-hard" | "gruvbox-light-medium" | "gruvbox-light-soft" | "houston" | "kanagawa-dragon" | "kanagawa-lotus" | "kanagawa-wave" | "laserwave" | "light-plus" | "material-theme" | "material-theme-darker" | "material-theme-lighter" | "material-theme-ocean" | "material-theme-palenight" | "min-dark" | "min-light" | "monokai" | "night-owl" | "nord" | "one-dark-pro" | "one-light" | "plastic" | "poimandres" | "red" | "rose-pine" | "rose-pine-dawn" | "rose-pine-moon" | "slack-dark" | "slack-ochin" | "snazzy-light" | "solarized-dark" | "solarized-light" | "synthwave-84" | "tokyo-night" | "vesper" | "vitesse-black" | "vitesse-dark" | "vitesse-light" | "css-variables";
dark: "andromeeda" | "aurora-x" | "ayu-dark" | "catppuccin-frappe" | "catppuccin-latte" | "catppuccin-macchiato" | "catppuccin-mocha" | "dark-plus" | "dracula" | "dracula-soft" | "everforest-dark" | "everforest-light" | "github-dark" | "github-dark-default" | "github-dark-dimmed" | "github-dark-high-contrast" | "github-light" | "github-light-default" | "github-light-high-contrast" | "gruvbox-dark-hard" | "gruvbox-dark-medium" | "gruvbox-dark-soft" | "gruvbox-light-hard" | "gruvbox-light-medium" | "gruvbox-light-soft" | "houston" | "kanagawa-dragon" | "kanagawa-lotus" | "kanagawa-wave" | "laserwave" | "light-plus" | "material-theme" | "material-theme-darker" | "material-theme-lighter" | "material-theme-ocean" | "material-theme-palenight" | "min-dark" | "min-light" | "monokai" | "night-owl" | "nord" | "one-dark-pro" | "one-light" | "plastic" | "poimandres" | "red" | "rose-pine" | "rose-pine-dawn" | "rose-pine-moon" | "slack-dark" | "slack-ochin" | "snazzy-light" | "solarized-dark" | "solarized-light" | "synthwave-84" | "tokyo-night" | "vesper" | "vitesse-black" | "vitesse-dark" | "vitesse-light" | "css-variables";
} | undefined;
} | undefined;
latex?: boolean | undefined;
} | undefined;
banner?: {
content: string;
dismissible?: boolean | undefined;
} | undefined;
errors?: {
'404': {
title?: string | undefined;
description?: string | undefined;
redirect?: boolean | undefined;
};
} | undefined;
contextual?: {
options: ("copy" | "view" | "chatgpt" | "claude" | "perplexity" | "mcp" | "cursor" | "vscode" | {
href: string | {
base: string;
query?: {
value: string;
key: string;
}[] | undefined;
};
title: string;
description: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
})[];
} | undefined;
thumbnails?: {
background?: string | undefined;
appearance?: import("../index.js").ThumbnailAppearance | undefined;
fonts?: {
family: string;
} | undefined;
} | undefined;
interaction?: {
drilldown?: boolean | undefined;
} | undefined;
} | {
name: string;
theme: "aspen";
colors: {
primary: string;
light?: string | undefined;
dark?: string | undefined;
};
navigation: {
products: import("./schemas/v2/properties/navigation/divisionNav.js").ProductNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
languages: import("./schemas/v2/properties/navigation/divisionNav.js").LanguageNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
versions: import("./schemas/v2/properties/navigation/divisionNav.js").VersionNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
tabs: import("./schemas/v2/properties/navigation/divisionNav.js").TabNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
dropdowns: import("./schemas/v2/properties/navigation/divisionNav.js").DropdownNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
anchors: import("./schemas/v2/properties/navigation/divisionNav.js").AnchorNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
groups: ({
openapi: string | string[] | {
source: string;
directory?: string | undefined;
};
group: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
expanded?: boolean | undefined;
public?: boolean | undefined;
pages?: any[] | undefined;
tag?: string | undefined;
hidden?: boolean | undefined;
root?: string | undefined;
} | {
group: string;
asyncapi: string | string[] | {
source: string;
directory?: string | undefined;
};
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
expanded?: boolean | undefined;
public?: boolean | undefined;
pages?: any[] | undefined;
tag?: string | undefined;
hidden?: boolean | undefined;
root?: string | undefined;
} | {
group: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
expanded?: boolean | undefined;
public?: boolean | undefined;
pages?: any[] | undefined;
tag?: string | undefined;
hidden?: boolean | undefined;
root?: string | undefined;
})[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
pages: any[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
};
background?: {
color?: {
light?: string | undefined;
dark?: string | undefined;
} | undefined;
image?: string | {
light: string;
dark: string;
} | undefined;
decoration?: "gradient" | "grid" | "windows" | undefined;
} | undefined;
$schema?: string | undefined;
logo?: string | {
light: string;
dark: string;
href?: string | undefined;
} | undefined;
favicon?: string | {
light: string;
dark: string;
} | undefined;
api?: {
params?: {
expanded?: "all" | "closed" | undefined;
} | undefined;
openapi?: string | string[] | {
source: string;
directory?: string | undefined;
} | undefined;
playground?: {
display?: "simple" | "none" | "interactive" | undefined;
proxy?: boolean | undefined;
} | undefined;
asyncapi?: string | string[] | {
source: string;
directory?: string | undefined;
} | undefined;
examples?: {
languages?: string[] | undefined;
defaults?: "all" | "required" | undefined;
prefill?: boolean | undefined;
} | undefined;
mdx?: {
server?: string | string[] | undefined;
auth?: {
name?: string | undefined;
method?: "key" | "bearer" | "basic" | "cobo" | undefined;
} | undefined;
} | undefined;
} | undefined;
metadata?: {
timestamp?: boolean | undefined;
} | undefined;
footer?: {
links?: {
items: {
href: string;
label: string;
}[];
header?: string | undefined;
}[] | undefined;
socials?: Partial<Record<"github" | "x" | "website" | "facebook" | "youtube" | "discord" | "slack" | "linkedin" | "instagram" | "hacker-news" | "medium" | "telegram" | "twitter" | "x-twitter" | "earth-americas" | "bluesky" | "threads" | "reddit" | "podcast", string>> | undefined;
} | undefined;
integrations?: {
amplitude?: {
apiKey: string;
} | undefined;
clarity?: {
projectId: string;
} | undefined;
clearbit?: {
publicApiKey: string;
} | undefined;
fathom?: {
siteId: string;
} | undefined;
ga4?: {
measurementId: string;
} | undefined;
gtm?: {
tagId: string;
} | undefined;
heap?: {
appId: string;
} | undefined;
hightouch?: {
writeKey: string;
apiHost?: string | undefined;
} | undefined;
hotjar?: {
hjid: string;
hjsv: string;
} | undefined;
koala?: {
publicApiKey: string;
} | undefined;
logrocket?: {
appId: string;
} | undefined;
mixpanel?: {
projectToken: string;
} | undefined;
pirsch?: {
id: string;
} | undefined;
posthog?: {
apiKey: string;
apiHost?: string | undefined;
} | undefined;
plausible?: {
domain: string;
server?: string | undefined;
} | undefined;
segment?: {
key: string;
} | undefined;
intercom?: {
appId: string;
} | undefined;
frontchat?: {
snippetId: string;
} | undefined;
osano?: {
scriptSource: string;
} | undefined;
telemetry?: {
enabled?: boolean | undefined;
} | undefined;
cookies?: {
value?: string | undefined;
key?: string | undefined;
} | undefined;
} | undefined;
search?: {
prompt?: string | undefined;
} | undefined;
redirects?: {
source: string;
destination: string;
permanent?: boolean | undefined;
}[] | undefined;
seo?: {
metatags?: Record<string, string> | undefined;
indexing?: "all" | "navigable" | undefined;
} | undefined;
description?: string | undefined;
appearance?: {
strict?: boolean | undefined;
default?: "light" | "dark" | "system" | undefined;
} | undefined;
fonts?: {
family: string;
source?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | {
body?: {
family: string;
source?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
heading?: {
family: string;
source?: string | undefined;
weight?: number | undefined;
format?: "woff" | "woff2" | undefined;
} | undefined;
} | undefined;
navbar?: {
primary?: {
type: "button";
href: string;
label: string;
} | {
type: "github";
href: string;
} | undefined;
links?: {
href: string;
label: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
}[] | undefined;
} | undefined;
icons?: {
library: "fontawesome" | "lucide";
} | undefined;
styling?: {
eyebrows?: "section" | "breadcrumbs" | undefined;
codeblocks?: "dark" | "system" | {
languages?: {
custom?: string[] | undefined;
} | undefined;
theme?: "andromeeda" | "aurora-x" | "ayu-dark" | "catppuccin-frappe" | "catppuccin-latte" | "catppuccin-macchiato" | "catppuccin-mocha" | "dark-plus" | "dracula" | "dracula-soft" | "everforest-dark" | "everforest-light" | "github-dark" | "github-dark-default" | "github-dark-dimmed" | "github-dark-high-contrast" | "github-light" | "github-light-default" | "github-light-high-contrast" | "gruvbox-dark-hard" | "gruvbox-dark-medium" | "gruvbox-dark-soft" | "gruvbox-light-hard" | "gruvbox-light-medium" | "gruvbox-light-soft" | "houston" | "kanagawa-dragon" | "kanagawa-lotus" | "kanagawa-wave" | "laserwave" | "light-plus" | "material-theme" | "material-theme-darker" | "material-theme-lighter" | "material-theme-ocean" | "material-theme-palenight" | "min-dark" | "min-light" | "monokai" | "night-owl" | "nord" | "one-dark-pro" | "one-light" | "plastic" | "poimandres" | "red" | "rose-pine" | "rose-pine-dawn" | "rose-pine-moon" | "slack-dark" | "slack-ochin" | "snazzy-light" | "solarized-dark" | "solarized-light" | "synthwave-84" | "tokyo-night" | "vesper" | "vitesse-black" | "vitesse-dark" | "vitesse-light" | "css-variables" | {
light: "andromeeda" | "aurora-x" | "ayu-dark" | "catppuccin-frappe" | "catppuccin-latte" | "catppuccin-macchiato" | "catppuccin-mocha" | "dark-plus" | "dracula" | "dracula-soft" | "everforest-dark" | "everforest-light" | "github-dark" | "github-dark-default" | "github-dark-dimmed" | "github-dark-high-contrast" | "github-light" | "github-light-default" | "github-light-high-contrast" | "gruvbox-dark-hard" | "gruvbox-dark-medium" | "gruvbox-dark-soft" | "gruvbox-light-hard" | "gruvbox-light-medium" | "gruvbox-light-soft" | "houston" | "kanagawa-dragon" | "kanagawa-lotus" | "kanagawa-wave" | "laserwave" | "light-plus" | "material-theme" | "material-theme-darker" | "material-theme-lighter" | "material-theme-ocean" | "material-theme-palenight" | "min-dark" | "min-light" | "monokai" | "night-owl" | "nord" | "one-dark-pro" | "one-light" | "plastic" | "poimandres" | "red" | "rose-pine" | "rose-pine-dawn" | "rose-pine-moon" | "slack-dark" | "slack-ochin" | "snazzy-light" | "solarized-dark" | "solarized-light" | "synthwave-84" | "tokyo-night" | "vesper" | "vitesse-black" | "vitesse-dark" | "vitesse-light" | "css-variables";
dark: "andromeeda" | "aurora-x" | "ayu-dark" | "catppuccin-frappe" | "catppuccin-latte" | "catppuccin-macchiato" | "catppuccin-mocha" | "dark-plus" | "dracula" | "dracula-soft" | "everforest-dark" | "everforest-light" | "github-dark" | "github-dark-default" | "github-dark-dimmed" | "github-dark-high-contrast" | "github-light" | "github-light-default" | "github-light-high-contrast" | "gruvbox-dark-hard" | "gruvbox-dark-medium" | "gruvbox-dark-soft" | "gruvbox-light-hard" | "gruvbox-light-medium" | "gruvbox-light-soft" | "houston" | "kanagawa-dragon" | "kanagawa-lotus" | "kanagawa-wave" | "laserwave" | "light-plus" | "material-theme" | "material-theme-darker" | "material-theme-lighter" | "material-theme-ocean" | "material-theme-palenight" | "min-dark" | "min-light" | "monokai" | "night-owl" | "nord" | "one-dark-pro" | "one-light" | "plastic" | "poimandres" | "red" | "rose-pine" | "rose-pine-dawn" | "rose-pine-moon" | "slack-dark" | "slack-ochin" | "snazzy-light" | "solarized-dark" | "solarized-light" | "synthwave-84" | "tokyo-night" | "vesper" | "vitesse-black" | "vitesse-dark" | "vitesse-light" | "css-variables";
} | undefined;
} | undefined;
latex?: boolean | undefined;
} | undefined;
banner?: {
content: string;
dismissible?: boolean | undefined;
} | undefined;
errors?: {
'404': {
title?: string | undefined;
description?: string | undefined;
redirect?: boolean | undefined;
};
} | undefined;
contextual?: {
options: ("copy" | "view" | "chatgpt" | "claude" | "perplexity" | "mcp" | "cursor" | "vscode" | {
href: string | {
base: string;
query?: {
value: string;
key: string;
}[] | undefined;
};
title: string;
description: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "lucide" | undefined;
} | undefined;
})[];
} | undefined;
thumbnails?: {
background?: string | undefined;
appearance?: import("../index.js").ThumbnailAppearance | undefined;
fonts?: {
family: string;
} | undefined;
} | undefined;
interaction?: {
drilldown?: boolean | undefined;
} | undefined;
} | {
name: string;
theme: "linden";
colors: {
primary: string;
light?: string | undefined;
dark?: string | undefined;
};
navigation: {
products: import("./schemas/v2/properties/navigation/divisionNav.js").ProductNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
languages: import("./schemas/v2/properties/navigation/divisionNav.js").LanguageNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
versions: import("./schemas/v2/properties/navigation/divisionNav.js").VersionNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
tabs: import("./schemas/v2/properties/navigation/divisionNav.js").TabNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
dropdowns: import("./schemas/v2/properties/navigation/divisionNav.js").DropdownNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
anchors: import("./schemas/v2/properties/navigation/divisionNav.js").AnchorNavigation<"default">[];
global?: import("./schemas/v2/properties/navigation/divisionNav.js").GlobalNavigation | undefined;
} | {
groups: ({
openapi: string | string[] | {
source: string;
directory?: string | undefined;
};
group: string;
icon?: string | {
name: string;
style?: "brands" | "duotone" | "light" | "regular" | "sharp-duotone-solid" | "sharp-light" | "sharp-regular" | "sharp-solid" | "sharp-thin" | "solid" | "thin" | undefined;
library?: "fontawesome" | "