Theme-Konfiguration
Diese Referenz wird automatisch aus den Theme-Typdefinitionen und Default-Werten generiert.
| Eigenschaft | Typ | Erforderlich | Default | Beschreibung |
|---|---|---|---|---|
| glossaryPage | string | false | — | |
| feedback | FeedbackProps | false | — | |
| layoutComponent | (props: PropsWithChildren) => ReactNode | false | — | |
| docsRepositoryBase | string | false | — | |
| project | { link?: string; icon?: ReactNode | FC; } | false | — | |
| project.link | string | false | — | |
| project.icon | ReactNode | FC | false | — | |
| umbrellaFooter | boolean | false | false | |
| umbrellaHeader | boolean | false | false | |
| i18n | { uiElementTranslation?: { [locale: string]: Partial<typeof messages.en>; }; } | false | — | |
| i18n.uiElementTranslation | { [locale: string]: Partial<typeof messages.en>; } | false | — | |
| banner | FC | false | — | |
| header | { component?: ReactNode | FC; centerElement?: ReactNode | FC; lowerBadgeLogoPath?: string; } | false | — | |
| header.component | ReactNode | FC | false | — | |
| header.centerElement | ReactNode | FC | false | — | |
| header.lowerBadgeLogoPath | string | false | — | |
| disableSearch | boolean | true | false | |
| hidePrimaryMenu | boolean | true | false | |
| primaryMenu | { title: string; iconEnabled?: boolean; } | false | — | |
| primaryMenu.title | string | true | — | |
| primaryMenu.iconEnabled | boolean | false | — | |
| faviconGlyph | string | false | — | |
| accessibilityLanguages | { leichteSpracheHref?: string; gebaerdenSprachenHref?: string; } | false | — | |
| accessibilityLanguages.leichteSpracheHref | string | false | — | |
| accessibilityLanguages.gebaerdenSprachenHref | string | false | — | |
| footer | { component?: ReactNode | FC<{ menu: boolean; }>; links?: Array<{ name: string; href: string; column: string; }>; logo?: ReactNode | FC; description?: ReactNode | FC; copyright?: ReactNode | FC; } | true | — | |
| footer.component | ReactNode | FC<{ menu: boolean; }> | false | [ref:Footer] | |
| footer.links | Array<{ name: string; href: string; column: string; }> | false | [array] | |
| footer.logo | ReactNode | FC | false | — | |
| footer.description | ReactNode | FC | false | null | |
| footer.copyright | ReactNode | FC | false | [complex] | |
| toc | { disable?: boolean; title?: string; iconEnabled?: boolean; footer?: ReactNode; } | false | — | |
| toc.disable | boolean | false | — | |
| toc.title | string | false | — | |
| toc.iconEnabled | boolean | false | — | |
| toc.footer | ReactNode | false | — | |
| head | ReactNode | false | — | |
| logo | ReactNode | FC | false | [jsx] | |
| logoText | string | false | "" | |
| logoLink | boolean | string | true | true | |
| notFound | { content: ReactNode | FC; labels: string; } | true | — | |
| notFound.content | ReactNode | FC | true | Submit an issue about broken link → | |
| notFound.labels | string | true | bug | |
| search | { component?: ReactNode | FC<{ className?: string; }>; emptyResult?: ReactNode | FC; error?: string | (() => string); loading?: ReactNode | FC; placeholder?: string | (() => string); renderResult?: FC<SearchResultRendererProps>; } | true | — | |
| search.component | ReactNode | FC<{ className?: string; }> | false | [ref:Flexsearch] | |
| search.emptyResult | ReactNode | FC | false | [complex] | |
| search.error | string | (() => string) | false | — | |
| search.loading | ReactNode | FC | false | — | |
| search.placeholder | string | (() => string) | false | — | |
| search.renderResult | FC<SearchResultRendererProps> | false | — | Custom renderer for individual search result items. Receives title, content, route, and the current search query. |
| sidebar | { disable: boolean; autoCollapse?: boolean; defaultMenuCollapseLevel: number; toggleButton: boolean; } | true | — | |
| sidebar.disable | boolean | true | true | |
| sidebar.autoCollapse | boolean | false | — | |
| sidebar.defaultMenuCollapseLevel | number | true | 2 | |
| sidebar.toggleButton | boolean | true | true | |
| editPage | { enabled: boolean; description?: string; repoBaseUrl: string; icon?: "auto" | "edit" | "github" | "opencode" | "gitlab" | "none"; } | true | — | |
| editPage.enabled | boolean | true | false | |
| editPage.description | string | false | Diese Seite bearbeiten | |
| editPage.repoBaseUrl | string | true | "" | |
| editPage.icon | "auto" | "edit" | "github" | "opencode" | "gitlab" | "none" | false | auto | |
| theme | ThemeProviderProps | false | — |