Reference
/Settings
Settings
Main settings interface for the application
Properties
themeThemename"poetry" | "cosmo" | "opener" | "picasso" | "gusto" | "solar" | stringRequiredlogoLogoLogolightstringdarkstringhrefstringpagestringstringstringReact.JSX.ElementReact.JSX.ElementfontsThemeFontFontFontfamilystringweightstringsrcstringformat"woff2" | "woff" | "ttf"Font[]Font[]faviconstringiconsIconslibraryIconLibraryIconLibrarynamestringRequiredversionstringdefaultbooleannoprefixbooleanstringstringIconLibrary[]IconLibrary[]appearanceAppearancecolorScheme"light" | "dark" | "os"colorSchemeButtoncolorsColorsprimarystringRequiredlightstringdarkstringcssTokenspresetsstring[]logoAppearanceLogosidebarboolean | "mobile" | "desktop"headerboolean | "mobile" | "desktop"searchAppearanceSearchfullWidthbooleansidebarboolean | "mobile" | "desktop"middleboolean | "mobile" | "desktop"rightboolean | "mobile" | "desktop"headerAppearanceHeaderexternalArrowbooleanseparator"right"type"classic" | "pad"buttonSize"sm" | "md" | "lg"tabsAppearanceTabssurface"center" | "sidebar"sidebarAppearanceSidebarexternalArrowbooleanscrollShadowbooleanscrollbar"secondary"scrollbarColorstringscrollTransition"smooth" | "instant"buttonsAppearanceButtonsroundedboolean | "sm" | "md" | "lg"tablesAppearanceTableskind"secondary"bannerAppearanceBannerfixedbooleancontentAppearanceContentcontentDecorator"secondary"breadcrumbsbooleansectionSeparatorbooleanfooterAppearanceFootersurface"page"writerWritermaxTocDepthnumbercopyPagebooleancoderCoderlinesbooleanscrollbooleansyntaxHighlightThemeheadarray of HeadConfig [string, Record<string, string | boolean>, ]scriptsstring[]navigationNavigationsidebararray of SidebarNavigationSidebarRouteSidebarRouteroutestringRequiredgroupstringidstringpagesRequiredSidebarSidebargroupstringpagesarray of PageURLSidebarSidebargroupstringpagesarray of PageURLiconstringorderOrderstringstringiconstringorderOrderstringstringtabsarray of Tabs NavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodesidebarDropdownarray of SidebarDropdown NavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodesegmentsarray of SegmentroutestringRequiredtitlestringappearance"sidebarDropdown"pagesarray of NavigationItemRequiredtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodeanchorsAnchorsheaderarray of AnchorHeaderNavigationItemNavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodeNavigationItemButtonNavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodeNavigationItemSocialNavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodesidebartoparray of NavigationItembottomarray of NavigationItemlanguagesarray of LanguageNavigationlanguagestringRequirednamestringdefaultbooleandir"ltr" | "rtl"overridesPartial<Settings>sidebararray of SidebarNavigationSidebarRouteSidebarRouteroutestringRequiredgroupstringidstringpagesRequiredSidebarSidebargroupstringpagesarray of PageURLSidebarSidebargroupstringpagesarray of PageURLiconstringorderOrderstringstringiconstringorderOrderstringstringtabsarray of Tabs NavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodesidebarDropdownarray of SidebarDropdown NavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodesegmentsarray of SegmentroutestringRequiredtitlestringappearance"sidebarDropdown"pagesarray of NavigationItemRequiredtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodeanchorsAnchorsheaderarray of AnchorHeaderNavigationItemNavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodeNavigationItemButtonNavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodeNavigationItemSocialNavigationItemtitlestringdescriptionstringpagestringhrefstringiconReact.ReactNodesidebartoparray of NavigationItembottomarray of NavigationItemapiAPIopenapiAPIFileAPIFileMapAPIFileAdvancedAPIFileAdvancedsourcestringRequiredroutestringinfoAPIInfobaseUrlstringauthAPIAuthmethod"bearer" | "basic" | "key"RequirednamestringinputPrefixstringrequestAPIInfoRequestexamplelanguagesstring[]stringstringstring[]string[]graphqlAPIFileAPIFileMapAPIFileAdvancedAPIFileAdvancedsourcestringRequiredroutestringinfoAPIInfobaseUrlstringauthAPIAuthmethod"bearer" | "basic" | "key"RequirednamestringinputPrefixstringrequestAPIInfoRequestexamplelanguagesstring[]stringstringstring[]string[]sourcesAPIFileAPIFileMapAPIFileAdvancedAPIFileAdvancedsourcestringRequiredroutestringinfoAPIInfobaseUrlstringauthAPIAuthmethod"bearer" | "basic" | "key"RequirednamestringinputPrefixstringrequestAPIInfoRequestexamplelanguagesstring[]stringstringstring[]string[]integrationsIntegrationsanalyticsIntegrationAnalyticslivesessionIntegrationAnalyticsLiveSessiontrackIdstringRequiredsupportIntegrationSupportchatwootIntegrationSupportChatwootwebsiteTokenstringRequiredbaseURLstringchatwootSettingsJSONintercomIntegrationSupportIntercomappIdstringRequiredapiBasestringlivechatIntegrationSupportLivechatlicenseIdstringRequiredsearchIntegrationSearchalgoliaappIdstringRequiredapiKeystringRequiredoramabooleanabtestingIntegrationABTestingcontextMaxAgenumbercontextStorageKeystringprovidersIntegrationABTestingProvidersgrowthbookIntegrationABTestingGrowthBookapiHoststringRequiredclientKeystringRequiredlaunchdarklyIntegrationABTestingLaunchDarklyenvstringRequireddiagramsDiagramsConfigDiagramsConfigmermaid"img-png" | "img-svg" | "inline-svg" | "pre-mermaid" | booleangraphviz.configinteractivebooleanbooleanbooleanDiagramType[]DiagramType[]editLinkEditLinkbaseUrlstringRequiredtitlestringiconstring.appsAppsDirectorygithubStarIntegrationAppGithubStartitlestringRequiredlabelstringhrefstringRequireddataShowCountbooleandataIconstringdataSizestringariaLabelstringsupademoIntegrationAppSupademoapiKeystringRequiredpluginsarray of PluginsPluginConfig[PluginName, PluginArgs[]]stringstringseoSEOdomainstringmetatagsaiAIllmsTxtLLMsTxtLLMsTxttitlestringRequiredbaseUrlstringRequiredsummarystringsectionsstringstringadvancedAdvancedbasenamestringviteUserConfigcomponentsComponentsbannerWebEditorBannercontentComponentLikeRequiredJSONComponentJSONComponentcomponentstringRequiredpropsRecord<string, any>React.JSX.ElementReact.JSX.Elementstringstringlabelstringkind"secondary"hrefstringiconstringfooterWebEditorFooterkind"minimal"logoComponentLikeComponentLikeJSONComponentJSONComponentcomponentstringRequiredpropsRecord<string, any>React.JSX.ElementReact.JSX.ElementstringstringbooleanbooleansocialxstringfacebookstringyoutubestringdiscordstringslackstringgithubstringlinkedinstringinstagramstringhackernewsstringmediumstringtelegramstringblueskystringredditstringlinksWebEditorFooterLinksfootnoteComponentLikeJSONComponentJSONComponentcomponentstringRequiredpropsRecord<string, any>React.JSX.ElementReact.JSX.ElementstringstringengineEnginepathsuniformEngineUniformstorebooleanaccessControlAccessControlproviderRequiredAccessControlProviderOAuthAccessControlProviderOAuthtype"oauth"RequiredauthorizationUrlstringRequiredtokenUrlstringRequiredclientIdstringRequiredscopesstring[]callbackPathstringuserInfoUrlstringgroupsClaimstringAccessControlProviderJWTAccessControlProviderJWTtype"jwt"RequiredloginUrlstringRequiredcallbackPathstringalgorithm"EdDSA" | "RS256" | "HS256"jwksUrlstringsecretstringgroupsClaimstringAccessControlProviderCustomAccessControlProviderCustomtype"custom"RequiredhandlerstringRequireddefaultAccess"public" | "protected"rulesarray of AccessControlRulematchstringRequiredaccess"public" | "protected"Requiredgroupsstring[]login- String: path to a custom component (e.g., "./my-login.tsx"). The component receives useAccessControl() context automatically.
- Object: configuration for the built-in login page.
AccessControlLoginConfigAccessControlLoginConfigpagestringlogostringtitlestringdescriptionstringbackgroundImagestringstringstringunauthorizedBehavior"redirect" | "404"deployAccessControlDeployConfigplatform"netlify-edge" | "vercel-edge" | "cloudflare-edge" | "node-edge"RequiredsessionAccessControlSessionConfigmaxAgenumbercookieNamestringi18nI18nConfigdefaultLocalestringdetectLanguagebooleancatalogsRecord<string, string | TranslationCatalog>
Theme configuration for the application
A theme name.
Path to logo image or object with path to "light" and "dark" mode logo images, and where the logo links to.
Logo configuration interface
Path to the logo in light mode. For example: /path/to/logo.svg
Path to the logo in dark mode. For example: /path/to/logo.svg
External href to when clicking on the logo
The page to link to when clicking on the logo
Font configuration for the theme.
The font family to use.
The font weight to use.
The font src to use.
The font format to use.
Path to the favicon image. For example: /path/to/favicon.svg
The iconify library setup.
The iconify library
The iconify library name
The iconify library version
The default iconify icon name
Merge icons from the library into the default iconify library
Appearance configuration for the theme.
The default color scheme to use.
If false then the color scheme button will not be displayed.
Colors configuration for the theme.
The primary color of the theme.
The light color of the theme.
The dark color of the theme.
CSS tokens for the theme.
Presets for the theme.
Logo appearance for the theme.
If true then the logo will be displayed on the sidebar.
If true then the logo will be displayed on the header.
Search appearance for the theme.
If true then the search bar will be displayed as a full width.
If true then the search bar will be displayed on the sidebar.
If true then the search bar will be displayed in the middle of the header.
If true then the search bar will be displayed on the right side of the header.
Header appearance for the theme.
If true then the header external links will display an external arrow.
If right then separator will be displayed on the right side of the header.
The type of the header.
The button size of the header.
Tabs appearance for the theme.
The tabs to display in the header.
Sidebar appearance for the theme.
If true then the sidebar will display a scroll shadow.
If true then the sidebar will display a scroll shadow.
The color of the sidebar scrollbar.
The color of the sidebar scrollbar.
The transition behaviour of the sidebar scroll when navigating to a new page.
Buttons appearance for the theme.
Table appearance for the theme.
The kind of the table.
Banner appearance for the theme.
If true then the banner will have fixed position (always visible).
Content appearance for the theme.
Content decorator for the theme.
If true then the breadcrumbs will be displayed.
If true then the section separator will be displayed.
Footer appearance for the theme.
The footer surface.
Writer configuration for the theme.
The maximum number of table of conten§ts levels.
Copy page button
Coder configuration for the theme, including options like syntax highlighting.
If true then code blocks will have line numbers by default.
If true then code blocks will have a scrollbar by default.
Syntax highlighting configuration.
Configuration type for head elements that can be added to the HTML head.
Format: [tagName, attributes, content]
@example: ['script', { src: 'https://example.com/script.js', defer: true }]
Custom scripts to be added to the head of the every page.
Paths are relative to the root of the project or absolute.
Navigation configuration
Sidebar navigation type
Sidebar route configuration
Route for this sidebar
The group of the route
The id of the route
Sidebar pages within this route or sub routes
Sidebar configuration
The name of the group
Page URL type
Sidebar configuration
The name of the group
The relative paths to the markdown files that will serve as pages.
Note: groups are recursive, so to add a sub-folder add another group object in the page array.
The icon of the group.
The order of the group.
The icon of the group.
The order of the group.
Tabs configuration
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Sidebar dropdown navigation - navigation through dropdown in the sidebar.
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Segment configuration
Route for this segment
Title of this segment
Appearance of this segment. If 'sidebarDropdown' then show this segment as a dropdown in the sidebar if match.
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Anchors navigation - fixed navigation, for anchor-like elements.
Header anchors
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Sidebar anchors
Per-locale navigation block. Same shape as
`Navigation`
plus locale fields.
ISO 639-1 code for this locale. Used in URLs (
`/{language}/...`
).
Native display name shown in the locale switcher (
`Polski`
, not
`Polish`
).
Marks this entry as the default locale (URLs unprefixed).
Ignored when
`i18n.defaultLocale`
is set explicitly.
If neither is set, the first entry wins.
Text direction. Sets
`<html dir>`
on pages of this locale.
Defaults to
`"ltr"`
.
Per-locale overrides for top-level
`Settings`
keys (e.g.
`components.footer`
,
`theme.head`
,
`seo`
). Shallow-merged on top of root settings when serving
this locale. If you override
`components.footer`
, the whole footer config
is replaced for this locale.
Sidebar navigation type
Sidebar route configuration
Route for this sidebar
The group of the route
The id of the route
Sidebar pages within this route or sub routes
Sidebar configuration
The name of the group
Page URL type
Sidebar configuration
The name of the group
The relative paths to the markdown files that will serve as pages.
Note: groups are recursive, so to add a sub-folder add another group object in the page array.
The icon of the group.
The order of the group.
The icon of the group.
The order of the group.
Tabs configuration
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Sidebar dropdown for this locale.
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Segment configuration
Route for this segment
Title of this segment
Appearance of this segment. If 'sidebarDropdown' then show this segment as a dropdown in the sidebar if match.
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Anchors for this locale.
Header anchors
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Core interface for navigation items
The navigation item title
The navigation item description
The navigation page, if set it redirects to the page + matches based on routing
The navigation href, if set it redirects but does not match based on routing
The navigation item icon
Sidebar anchors
API Docs configuration
API file configuration. Can be a path, an array of paths, a map of paths, or an advanced configuration
API file map type
API file advanced type
Source configuration
Route configuration
API information configuration
The base url for all API endpoints. If baseUrl is an array, it will enable
for multiple base url options that the user can toggle.
Authentication information
The authentication strategy used for all API endpoints
The name of the authentication parameter used in the API playground.
If method is basic, the format should be [usernameName]:[passwordName]
The default value that's designed to be a prefisx for the authentication input field.
E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
Request configuration
Configurations for the auto-generated API request examples
An array of strings that determine the order of the languages of the auto-generated request examples.
You can either define custom languages utilizing x-codeSamples or use our default languages which include
bash, python, javascript, php, go, java
API file configuration. Can be a path, an array of paths, a map of paths, or an advanced configuration
API file map type
API file advanced type
Source configuration
Route configuration
API information configuration
The base url for all API endpoints. If baseUrl is an array, it will enable
for multiple base url options that the user can toggle.
Authentication information
The authentication strategy used for all API endpoints
The name of the authentication parameter used in the API playground.
If method is basic, the format should be [usernameName]:[passwordName]
The default value that's designed to be a prefisx for the authentication input field.
E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
Request configuration
Configurations for the auto-generated API request examples
An array of strings that determine the order of the languages of the auto-generated request examples.
You can either define custom languages utilizing x-codeSamples or use our default languages which include
bash, python, javascript, php, go, java
API file configuration. Can be a path, an array of paths, a map of paths, or an advanced configuration
API file map type
API file advanced type
Source configuration
Route configuration
API information configuration
The base url for all API endpoints. If baseUrl is an array, it will enable
for multiple base url options that the user can toggle.
Authentication information
The authentication strategy used for all API endpoints
The name of the authentication parameter used in the API playground.
If method is basic, the format should be [usernameName]:[passwordName]
The default value that's designed to be a prefisx for the authentication input field.
E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
Request configuration
Configurations for the auto-generated API request examples
An array of strings that determine the order of the languages of the auto-generated request examples.
You can either define custom languages utilizing x-codeSamples or use our default languages which include
bash, python, javascript, php, go, java
Integrations configuration
Configurations to add third-party analytics integrations.
See full list of supported analytics here.
LiveSession analytics configuration
LiveSession's TrackID
Configurations to add third-party support integrations.
Chatwoot support configuration
Chatwoot website token
Chatwoot base URL
Chatwoot settings
Intercom support configuration
Intercom app ID
Intercom API base
Livechat support configuration
Livechat license ID
Configurations to add third-party search integrations.
See full list of supported search here.
Algolia search configuration
Algolia application ID
Algolia API key
A/B testing configuration
Context max age in milliseconds
Context storage key used to store the context in the browser storage
Providers configuration
GrowthBook configuration
GrowthBook API host
GrowthBook client key
LaunchDarkly configuration
LaunchDarkly environment key
Diagrams configuration
Diagrams configuration object
Mermaid diagram configuration
true : Enable with default settings
: Enable with custom settings
Graphviz diagram configuration
true : Enable with default settings
: Enable with custom settings
Detailed diagram config, useful for e.g setting diagram's interactive.
Edit link configuration
The base URL for the edit link
The title for the edit link
The icon for the edit link
Custom apps directory.
Github star app configuration.
The title of the Github button
The label of the Github Button
The href of the Github project
The data-show-count of the Github project
The data-icon of the Github button
The data-size of the Github button
The aria-label of the Github button
Supademo app configuration.
The Supademo API key
Plugin configuration
SEO configuration
Domain name
Meta tags
AI configuration
LLMs txt configuration
LLMs txt configuration
Title of the LLMs txt
Base URL of the LLMs txt
Description of the LLMs txt
Sections of the LLMs txt
Advanced configuration
basename
Custom Vite configuration overrides.
Merged with xyd's internal Vite config.
Components configuration
WebEditor banner configuration
A type that can be used to represent a component-like structure.
JSON representation of a component.
The component type, e.g. "Button", "Card", etc.
The component's children, which can be a string, an array of strings, or an array of JSONComponent objects.
Banner label.
Banner kind.
Banner href.
Banner icon.
WebEditor footer configuration
A type that can be used to represent a component-like structure.
JSON representation of a component.
The component type, e.g. "Button", "Card", etc.
The component's children, which can be a string, an array of strings, or an array of JSONComponent objects.
Footer socials
Footer links
A type that can be used to represent a component-like structure.
JSON representation of a component.
The component type, e.g. "Button", "Card", etc.
The component's children, which can be a string, an array of strings, or an array of JSONComponent objects.
Engine configuration - advanced engine-like configuration
Path aliases for imports. Avoid long relative paths by creating shortcuts.
Uniform configuration
If true then virtual pages will not created and generated content will be stored on disk
Access control configuration.
Enables page-level access control on documentation sites.
Protected page content is never included in HTML source --
it is code-split into separate JS chunks loaded only after authentication.
Authentication provider configuration
OAuth 2.0 authorization URL
OAuth 2.0 token endpoint URL
OAuth 2.0 client ID. Use $ENV_VAR syntax for secrets.
OAuth 2.0 scopes to request
Callback path for OAuth redirect.
URL to fetch user info after auth (provides groups)
Field in user info response containing groups/roles
URL to redirect unauthenticated users for login
Callback path where JWT is delivered via hash fragment.
JWT signing algorithm.
JWKS URL for key verification (EdDSA/RS256)
Shared secret for HS256 verification. Use $ENV_VAR syntax.
JWT claim name containing user groups/roles
Path to custom auth handler module
Default access level for all pages.
"protected" = all pages require auth unless marked public.
"public" = all pages are public unless marked protected.
Pattern-based access rules, evaluated in order. First match wins.
Glob pattern matching page paths
Access level for matched pages
Groups allowed access (only for "protected" access)
Login page configuration.
Custom login page (path to mdx file)
Logo to display on the default login page
Title text on the login page
Description text on the login page
Background image URL for the login page
Behavior when user is unauthorized.
"redirect" sends to login page.
"404" shows not-found page (hides existence of protected page).
Deployment platform for server-side content protection
Target deployment platform
Session/token configuration
Session duration in seconds.
Cookie/storage key name.
Internationalization (i18n) configuration.
The required source of truth for i18n is navigation.languages[] . This i18n block is OPTIONAL and carries only site-wide flags (explicit defaultLocale override, browser detection, translation catalogs).
If navigation.languages[] is absent, this block has no effect.
Explicit default locale. Overrides any default: true shorthand on
navigation.languages[] entries when set. Must match a language declared in navigation.languages[] .
When true , redirect / based on navigator.language / xyd-locale
cookie. Default false .
Translation catalogs for "i18n: <key>" references in component config. Either a path to a JSON file, or an inline catalog object, keyed by locale code. If omitted, the framework auto-discovers
i18n/.json files at the project root.
Built with
Show your support! Star us on GitHub ⭐️