Definition
Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Mintlify Inheritance: System.ObjectSyntax
Summary
Configuration options for the Mintlify documentation renderer.Constructors
.ctor
Syntax
Properties
GenerateDocsJson
Gets or sets whether to generate the docs.json navigation file.Syntax
Property Value
Type:bool
True to generate docs.json alongside MDX files; otherwise, false.
Default is true.
GenerateNamespaceIndex
Gets or sets whether to generate index files for namespaces.Syntax
Property Value
Type:bool
True to generate index.mdx files for namespace documentation; otherwise, false.
Default is true.
IncludeIcons
Gets or sets whether to include icons in navigation and frontmatter.Syntax
Property Value
Type:bool
True to include FontAwesome icons; otherwise, false.
Default is true.
NamespaceOrder
Gets or sets the custom order for namespaces in navigation.Syntax
Property Value
Type:System.Collections.Generic.List<string>?
A list of namespace patterns in the desired order, or null for alphabetical ordering.
Supports wildcards (e.g., “System.*” matches all System namespaces).
NavigationMode
Gets or sets the navigation mode for multi-assembly documentation.Syntax
Property Value
Type:CloudNimble.DotNetDocs.Mintlify.NavigationMode
The navigation organization mode. Default is NavigationMode.Unified.
Template
Gets or sets a custom template for the docs.json configuration.Syntax
Property Value
Type:Mintlify.Core.Models.DocsJsonConfig?
A DocsJsonConfig instance to use as a template, or null to use defaults.
The navigation section will be generated automatically.
UnifiedGroupName
Gets or sets the group name used when NavigationMode is Unified.Syntax
Property Value
Type:string
The name of the unified API reference group. Default is “API Reference”.