Definition
Assembly: Mintlify.Core.dll Namespace: Mintlify.Core Inheritance: System.ObjectSyntax
Summary
Configuration options for Mintlify documentation generation.Remarks
This class contains all the configuration settings that control how the Mintlify documentation is generated, including output paths, filtering options, and formatting preferences.Constructors
.ctor
Syntax
Properties
AppearanceDefault
Gets or sets the default appearance mode (system, light, dark).Syntax
Property Value
Type:string
AppearanceStrict
Gets or sets whether to hide the light/dark mode toggle.Syntax
Property Value
Type:bool
BaseUrl
Gets or sets the base URL for cross-references to external documentation.Syntax
Property Value
Type:string
Clean
Gets or sets whether to clean the output directory before generating.Syntax
Property Value
Type:bool
ConfigOnly
Gets or sets whether to only generate the docs.json file without MDX files.Syntax
Property Value
Type:bool
FaviconDark
Gets or sets the dark mode favicon path.Syntax
Property Value
Type:string?
FaviconLight
Gets or sets the favicon path or light mode favicon.Syntax
Property Value
Type:string
ForceBuild
Gets or sets whether to force a rebuild instead of using existing binaries.Syntax
Property Value
Type:bool
Remarks
When false (default), DocFX will attempt to use existing compiled assemblies for faster documentation generation. When true, forces a complete rebuild which may be slower but ensures all dependencies are up to date.GenerateConfig
Gets or sets whether to generate a docs.json configuration file.Syntax
Property Value
Type:bool
GenerateNavigationFiles
Gets or sets whether to generate navigation.json files in non-api-reference folders.Syntax
Property Value
Type:bool
Remarks
When true, the generator will create navigation.json files in directories that don’t already have them, preserving the auto-discovered navigation structure. This allows users to customize navigation later without losing their changes during regeneration.GitHubUrl
Gets or sets the GitHub URL for footer social links.Syntax
Property Value
Type:string
IconLibrary
Gets or sets the icon library to use (fontawesome, lucide).Syntax
Property Value
Type:string
IncludeExamples
Gets or sets whether to include code examples in the generated documentation.Syntax
Property Value
Type:bool
IncludeInheritance
Gets or sets whether to include inheritance information.Syntax
Property Value
Type:bool
IncludeInternal
Gets or sets whether to include internal members in the documentation.Syntax
Property Value
Type:bool
IncludeSeeAlso
Gets or sets whether to include see also references.Syntax
Property Value
Type:bool
LogoDark
Gets or sets the path to the dark logo file.Syntax
Property Value
Type:string
LogoHref
Gets or sets the URL to redirect to when clicking the logo.Syntax
Property Value
Type:string?
LogoLight
Gets or sets the path to the light logo file.Syntax
Property Value
Type:string
MaxDepth
Gets or sets the maximum depth for nested type documentation.Syntax
Property Value
Type:int
NamespaceFilter
Gets or sets the namespace filter regex pattern. Only namespaces matching this pattern will be included.Syntax
Property Value
Type:string?
OutputDirectory
Gets or sets the output directory for generated documentation.Syntax
Property Value
Type:string
PreserveExistingConfig
Gets or sets whether to preserve existing docs.json configuration when updating.Syntax
Property Value
Type:bool
Remarks
When true (default), the generator will read any existing docs.json file and merge the generated API documentation with existing configuration, preserving custom navigation, styling, integrations, and other settings. When false, the generator will completely replace the docs.json file with new configuration.PrimaryColor
Gets or sets the primary color for the documentation theme.Syntax
Property Value
Type:string
PrimaryDarkColor
Gets or sets the primary color for dark mode.Syntax
Property Value
Type:string
SearchPrompt
Gets or sets the search prompt text.Syntax
Property Value
Type:string?
SeoIndexing
Gets or sets the SEO indexing mode (navigable, all).Syntax
Property Value
Type:string
SiteDescription
Gets or sets the description of the documentation site.Syntax
Property Value
Type:string
SiteName
Gets or sets the name of the documentation site.Syntax
Property Value
Type:string
SolutionNamePrefix
Gets or sets the solution name prefix to strip from project names when generating paths.Syntax
Property Value
Type:string?
Remarks
For example, if the solution is “CloudNimble.Breakdance” and projects are named “CloudNimble.Breakdance.AspNetCore”, the output path will be “/aspnetcore/” instead of “/cloudnimble-breakdance-aspnetcore/”.StripBackticksAroundLinks
Gets or sets whether to strip backticks around parameter and return value links.Syntax
Property Value
Type:bool
Remarks
When true (default), removes backticks around markdown links in parameter descriptions and return value documentation to ensure proper link rendering in Mintlify. This fixes the issue where links inside code formatting don’t render correctly.Theme
Gets or sets the theme for the documentation site.Syntax
Property Value
Type:string
TypeFilter
Gets or sets the type filter regex pattern. Only types matching this pattern will be included.Syntax
Property Value
Type:string?
Verbose
Gets or sets whether to enable verbose output during generation.Syntax
Property Value
Type:bool
WebsiteUrl
Gets or sets the website URL for footer social links.Syntax
Property Value
Type:string