Skip to main content

Types

Classes

NameSummary
AnchorConfigRepresents an anchor configuration in Mintlify navigation.
ApiConfigRepresents the API reference configuration and playground settings for Mintlify.
ApiExamplesConfigRepresents the configuration for autogenerated API examples in the documentation.
ApiParamsConfigRepresents the display settings for API parameters in the documentation.
ApiPlaygroundConfigRepresents the API playground settings for interactive documentation.
ApiSpecConfigRepresents an API specification configuration for OpenAPI or AsyncAPI.
AppearanceConfigRepresents the appearance configuration for light and dark mode settings in Mintlify.
BackgroundConfigRepresents the background configuration for the Mintlify documentation site.
BackgroundImageConfigRepresents a background image configuration in Mintlify.
BannerConfigRepresents the banner configuration for displaying announcements or notifications in the Mintlify documentation site.
ColorConfigRepresents a color configuration for Mintlify. Can be a simple hex color string or a complex color pair configuration with light and dark modes.
ColorPairConfigRepresents a color pair configuration for light and dark modes.
ColorsConfigRepresents the color configuration for Mintlify themes.
ContextualConfigRepresents the contextual options configuration for the Mintlify documentation site.
DocsJsonConfigRepresents the root configuration object for Mintlify docs.json.
DropdownConfigRepresents a dropdown configuration in Mintlify navigation.
Error404ConfigRepresents the configuration for 404 (Not Found) error handling in the Mintlify documentation site.
ErrorsConfigRepresents the error pages configuration for the Mintlify documentation site.
FaviconConfigRepresents the favicon configuration for Mintlify. Can be a single file or separate files for light and dark mode.
FaviconConfigJsonConverterCustom JSON converter for FaviconConfig that supports both string and object formats.
FontsConfigRepresents the font configuration for the Mintlify documentation site.
FooterConfigRepresents the footer configuration for Mintlify.
FooterLinkGroupRepresents a group of footer links.
FooterLinkRepresents a footer link.
FrontMatterConfigRepresents frontmatter configuration for Mintlify documentation pages.
GlobalAnchorConfigRepresents an anchor configuration for global navigation in the Mintlify documentation site.
GlobalDropdownConfigRepresents a dropdown configuration for global navigation in the Mintlify documentation site.
GlobalLanguageConfigRepresents a language configuration for global navigation in the Mintlify documentation site.
GlobalNavigationConfigRepresents global navigation configuration that appears on all sections and pages.
GlobalTabConfigRepresents a tab configuration for global navigation in the Mintlify documentation site.
GlobalVersionConfigRepresents a version configuration for global navigation in the Mintlify documentation site.
GroupConfigRepresents a group configuration in Mintlify navigation.
IconConfigRepresents an icon configuration in Mintlify.
IconsConfigRepresents the icon library configuration for the Mintlify documentation site.
IntegrationsConfigRepresents the integrations configuration for third-party services in the Mintlify documentation site.
InteractionConfigRepresents the interaction configuration for navigation elements in Mintlify.
LanguageConfigRepresents a language configuration in Mintlify navigation.
LogoConfigRepresents the logo configuration for Mintlify. Can be a single image path for both light and dark mode, or separate paths for each mode.
MdxConfigRepresents the MDX configuration for API pages generated from MDX files.
MdxAuthConfigRepresents the authentication configuration for MDX-based API documentation.
MenuConfigRepresents a menu item configuration in Mintlify navigation.
MergeOptionsDefines merging as combining two navigation structures into one integrated structure. Options control how different aspects of the merge are handled.
NavbarConfigRepresents the navigation bar configuration for the Mintlify documentation site.
NavbarLinkRepresents a navigation link in the Mintlify navbar.
NavigationConfigRepresents the navigation configuration for Mintlify.
NavigationContainerBaseBase class for navigation items that can contain groups and have external links.
NavigationItemBaseBase class for all navigation items in Mintlify.
NavigationSectionBaseBase class for top-level navigation sections (tabs, anchors, dropdowns).
PrimaryNavigationConfigRepresents the primary navigation configuration for Mintlify navbar. Can be a button configuration or a GitHub configuration.
ProductConfigRepresents a product configuration in Mintlify navigation.
RedirectConfigRepresents a URL redirect configuration for the Mintlify documentation site.
SearchConfigRepresents the search functionality configuration for the Mintlify documentation site.
SeoConfigRepresents the SEO (Search Engine Optimization) configuration for the Mintlify documentation site.
ServerConfigRepresents a server configuration for API endpoints.
StylingConfigRepresents the styling configuration for various UI elements in the Mintlify documentation site.
TabConfigRepresents a tab configuration in Mintlify navigation.
VersionConfigRepresents a version configuration in Mintlify navigation.