Definition
Assembly: CloudNimble.DotNetDocs.Mintlify.dll Namespace: CloudNimble.DotNetDocs.Mintlify Inheritance: System.ObjectSyntax
Summary
Configuration options for the Mintlify documentation renderer.Constructors
.ctor
Syntax
.ctor Inherited
Inherited from
objectSyntax
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).
Navigation
Gets or sets the navigation configuration for DotNetDocs-specific properties.Syntax
Property Value
Type:CloudNimble.DotNetDocs.Mintlify.DocsNavigationConfig
A DocsNavigationConfig instance that controls navigation mode, type, and name.
Default is a new instance with Mode=Unified, Type=Pages, and Name=null.
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”.
Methods
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?